0cd5d45706
Sphinx can be leveraged to auto-generate docs into feature-rich HTML pages. Docstrings in modules and classes can be easily auto-injected into documentation to produce high-level documentation, yet with accompanying code blocks and necessary docstrings. This commit introduces the tox job for auto-generating docs, as well as the foundational logic and documentation pages (index, HACKING and glossary). While hacking rules are introduced in HACKING.rst, they are not added in this commit; that will be done in a follow-up patchset. Additional documentation will also be included in a series of future patchsets. Change-Id: Iacd0e4542ebf481d66ab19dd43014b8d5bcc9e3f
20 lines
641 B
Plaintext
20 lines
641 B
Plaintext
# The order of packages is significant, because pip processes them in the order
|
|
# of appearance. Changing the order has an impact on the overall integration
|
|
# process, which may cause wedges in the gate later.
|
|
|
|
# Hacking already pins down pep8, pyflakes and flake8
|
|
hacking>=1.0.0 # Apache-2.0
|
|
|
|
coverage!=4.4,>=4.0 # Apache-2.0
|
|
fixtures>=3.0.0 # Apache-2.0/BSD
|
|
mox3!=0.19.0,>=0.7.0 # Apache-2.0
|
|
python-subunit>=0.0.18 # Apache-2.0/BSD
|
|
oslotest>=1.10.0 # Apache-2.0
|
|
os-testr>=0.8.0 # Apache-2.0
|
|
testrepository>=0.0.18 # Apache-2.0/BSD
|
|
testtools>=1.4.0 # MIT
|
|
bandit>=1.1.0 # Apache-2.0
|
|
sphinx>=1.6.2 # BSD
|
|
gabbi==1.35.1
|
|
sphinx_rtd_theme==0.2.4
|