1bb37b6857
Always use a def statement instead of an assignment statement that binds a lambda expression directly to an identifier. Yes: def f(x): return 2*x No: f = lambda x: 2*x https://www.python.org/dev/peps/pep-0008/ Change-Id: I776b80bb4bc2184125f461c801897f84d3f29254 |
||
---|---|---|
.. | ||
docbkx | ||
source | ||
.gitignore | ||
Makefile | ||
README.rst |
README.rst
Building the developer docs
For user and admin docs, go to the directory doc/docbkx.
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.