Translate Sphinx Docs

This Sphinx integration guide shows you how to translate Sphinx documentation in a few easy steps. Follow this tutorial to create multilingual Sphinx documentation translated to other languages for your international customers.

Below is a step by step guide for integrating Localize into your Sphinx documentation.

If you do not have a Localize Project yet, signup here!

1a. Copy the Localize Code Snippet into your index file for your Sphinx documentation.

Insert the code between your index.html file's <head> </head> tags:

<script src="https://global.localizecdn.com/localize.js"></script>
<script>!function(a){if(!a.Localize){a.Localize={};for(var e=["translate","untranslate","phrase","initialize","translatePage","setLanguage","getLanguage","detectLanguage","getAvailableLanguages","untranslatePage","bootstrap","prefetch","on","off","hideWidget","showWidget","getSourceLanguage"],t=0;t<e.length;t++)a.Localize[e[t]]=function(){}}}(window);</script>

<script>
  Localize.initialize({
    key: '[[app:key]]', 
    rememberLanguage: true,
    // other options go here, separated by commas
  });
</script>

1b. Add Initialization Options

Add any desired options to the Localize.initialize() call above, check here for the full list of possible options.

Some popular options include:

  • autoApprove - use to fully automate your translation workflow
  • localizeImages - allows for localization of images in your site

2. Load your Sphinx documentation in a browser.

  1. Visit your docs in a browser.
  2. Select one of your target languages using the language switching widget.
  3. Refresh the page.
  4. Lather, rinse, repeat, for each page in your docs.

Localize will automatically begin to detect new content on the pages that you visit, and will bring it into the Pending bin in your dashboard.

3. Approve phrases

Then head on over to the Manage Phrases page to approve phrases in the Localize dashboard.

4. Phrases not showing up?

If you are not seeing phrases show up in your Pending bin in the Localize dashboard, follow the troubleshooting instructions here.


Need Help?
Contact support for custom integration help or troubleshooting!


Did this page help you?