There's a regression in bandit 1.6.0 which causes bandit to stop respecting excluded directories, and our tests throw a bunch of violations. Blacklist this version, but allow newer versions as there is already a pull request to fix it, and I expect it will be included in the next release. Also fix the requirements job which was broken by https://review.opendev.org/657890 adding a cap on Sphinx on Python 2.  https://github.com/PyCQA/bandit/issues/488  https://github.com/PyCQA/bandit/pull/489 Change-Id: Ieabcd4e8c5e5354125a63e89b9b60931c760858a
|3 years ago|
|source||3 years ago|
|.gitignore||10 years ago|
|Makefile||8 years ago|
|README.rst||9 years ago|
|requirements.txt||3 years ago|
Building the developer docs
For user and admin docs, go to the directory doc/docbkx.
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.
Just type make to get help:
It will list available build targets.
To build the man pages:
To build the developer documentation as HTML:
Type make for more formats.
If you modify doc files, you can type:
to check whether the format has problem.