Sphinx-multilingual

This project intend to provide a template project to create a multi-language documentation with sphinx.

How to use?

Clone the project and change the “project-name”, “author-name” in config/all.py.

add/remove a language

let’s take fr as an example.

1. Make a new language folder, with en as a template

   cp -r en fr
       

2. Change conf.py in new folder.

   language = 'fr'
       

3. Add the new language to config/all.py (last line of the file)

   languages = ['en', 'zh-cn', 'fr']
       

Build the html?

make html

License

Licensed under the MIT License. You can feel free to use it.