Skip to content

Commit cfab202

Browse files
author
Chris Park
committed
Added docs README
1 parent 53fb72c commit cfab202

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

docs/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## Generating documentation with Sphinx
2+
3+
The best tutorial for generating documentation can be found [here](http://gisellezeno.com/tutorials/sphinx-for-python-documentation.html)
4+
5+
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
6+
7+
`sphinx-apidoc -f -o source/ ../rosette/`
8+
9+
This will overwrite the *.rst files, which may then require some editing to provide the desired look. Edits to date:
10+
1. index.rst: Changed the `Welcome ...` title to `Python Binding`
11+
1. index.rst: Added minor summary, "This is the API documentation for the Rosette API Python Binding. For examples and usage, please refer to our `API Guide <http://developer.rosette.com/api-guide>`_."
12+
13+
To change the logo, edit conf.py, `html_logo`
14+
15+
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.
16+
17+
You can view the generated html locally, by navigating to `docs/build/html` and opening `index.html`

0 commit comments

Comments
 (0)