cf99ff0165
>> Changed project name from plasma to valence in docs. >> Fixed docstring indentation. >> Added features docs. >> Added driver docs. >> Hidden licence headers from html files. Depends-On: Ia02bc00ad168b3c3d01ef6ca9696d43996091070 Change-Id: I1fa382d566165f5e76c84ad864024c0f546ef74c
1.4 KiB
1.4 KiB
Add a developer guide doc
Adding a new developer guide document generally takes three steps:
1. Write an rst file for doc
Write a new rst file for developer guide document, which should be placed correspondingly in valence/doc/source.
2. Check TOC tree for docs
We should check TOC tree ref for your newly added rst file, ensure that your rst file can be generated according to valence/doc/source/index.rst.
3. Generate docs
- Regenerate all the docs including your newly added rst file:
-
$ tox -e docs - Or, directly run sphinx in valence/doc:
-
$ python setup.py build_sphinx