Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 1.5 KB

README.md

File metadata and controls

23 lines (16 loc) · 1.5 KB

Generating documentation with Sphinx

The best tutorial for generating documentation can be found here

Files in the source directory are generally static and should not need to be updated. If another python module is created in ../rosette, then the source may need to be regenerated using

sphinx-apidoc -f -o source/ ../rosette/

This will overwrite the *.rst files, which may then require some editing to provide the desired look. Edits to date:

  1. index.rst: Changed the Welcome ... title to Python Binding
  2. index.rst: Added minor summary, "This is the API documentation for the Babel Street Analytics API Python Binding. For examples and usage, please refer to our API Guide <http://developer.babelstreet.com/api-guide>_."
  3. conf.py: removed blank line at end of file
  4. conf.py: added Babel Street logo
  5. conf.py: blank project (let logo handle it)
  6. conf.py: added version (auto updated by publish)
  7. conf.py: added author
  8. conf.py: enabled sys.path.insert(0, os.path.abspath('../..'))

To change the logo, edit conf.py, html_logo

To generate the html run make html. The output will be written to build/html. This is the step that is run by the publish.sh script when publishing the Python binding. Note that the version, which is noted in conf.py is not displayed anywhere, but is updated during the publish phase.

You can view the generated html locally, by navigating to docs/build/html and opening index.html