MultilingualCL

Building Documentation

Install documentation dependencies:

pip install -r requirements.txt

Generate HTML documentation:

sphinx-build -b html docs/ build/html

The generated site is in build/html/.

Some files are in Markdown. If needed, convert them to reStructuredText:

pandoc --from=markdown --to=rst --output=README.rst README.md

See docs.md for usage-oriented docs.

To regenerate API template files:

sphinx-apidoc -o docs multilingualcl/

This generates files such as:

Creating file docs/multilingualcl.rst.
Creating file docs/modules.rst.

To bootstrap a brand-new Sphinx config:

sphinx-quickstart

Then generate HTML:

sphinx-build -b html docs/ build/html

For theme or extension changes, edit conf.py. For content changes, edit the files in docs/ (.rst and .md).