openstack-doc-tools/HACKING.rst
caoyuan 74d2575a0e setup.cfg: Cleanup and update some urls to latest
- pbr hasn't need the hook configuration since forever [1]
- The 'wheel' group is renamed to 'bdist_wheel' [2]
- Update the urls to latest

[1] c84876dc0f
[2] f7c9878712

Change-Id: I52e7abcb577e3a9ba61492e84a3c148f6eab4b4a
2019-10-22 11:22:44 +08:00

26 lines
679 B
ReStructuredText

openstack-doc-tools style commandments
======================================
- Step 1: Read the OpenStack Style Commandments
https://docs.openstack.org/hacking/latest/
- Step 2: Read on
Running tests
-------------
So far there are some tests included with the package.
The openstack-indexpage tool is used while building the OpenStack
documentation repositories, test building of these repositories with
any changes done here.
Testing can be done with simply a local install of
openstack-doc-tools, then checking out the repositories and
running: ``tox`` inside of each.
The repositories using openstack-doc-tools include:
* api-site
* openstack-manuals
* security-doc