20a434c862
Make a few cleanups: - Remove python 2.7 stanza from setup.py - Add requires on python >= 3.6 to setup.cfg so that pypi and pip know about the requirement - Remove ancient sections from setup.cfg - Update requirements - Remove unused import from conf.py Change-Id: I87261d38992dedd87709ad8beff0bb533064e118 |
||
---|---|---|
.. | ||
source | ||
specs | ||
.gitignore | ||
Makefile | ||
README.rst | ||
requirements.txt |
README.rst
Building the developer docs
Dependencies
You'll need to install python Sphinx package and oslosphinx package:
sudo pip install sphinx oslosphinx
If you are using the virtualenv you'll need to install them in the virtualenv.
Get Help
Just type make to get help:
make
It will list available build targets.
Build Doc
To build the man pages:
make man
To build the developer documentation as HTML:
make html
Type make for more formats.
Test Doc
If you modify doc files, you can type:
make doctest
to check whether the format has problem.