Skip to content

Latest commit

 

History

History
19 lines (15 loc) · 609 Bytes

DOCUMENTATION.md

File metadata and controls

19 lines (15 loc) · 609 Bytes

How to improve the documentation

Add new contents

If possible, additional docstring should be written inside codes rather than in rst files.

Prepare

Install Sphinx pip install sphinx

Build

Build rst files and create html files, css files and so on. Run the following command in the root directory of machina's repository. sphinx-build -b html ./docs/source ./docs/_build/

Publish

Run the following command. cp -r docs/_build/ docs/ And send a pull request. If it is merged, we can see updated html here.