diff options
author | Nguyen Hai <nguyentrihai93@gmail.com> | 2018-03-16 01:35:19 +0900 |
---|---|---|
committer | Nguyen Hai <nguyentrihai93@gmail.com> | 2018-04-06 14:33:47 +0000 |
commit | 7ba42e091dad82b134f3acf73c72edccaca84830 (patch) | |
tree | 0cda91605e5bc22a46b343e69d32603af14445c6 /setup.cfg | |
parent | f5605d13e67c71c46538bafa5f7ddc18fb7427a6 (diff) | |
download | ironic-7ba42e091dad82b134f3acf73c72edccaca84830.tar.gz |
Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
[1] https://governance.openstack.org/tc/reference/project-testing-interface.html
[2] http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html
[doc/requirements.txt] & [test-requirements.txt]
To support documentation generation in new PTI, project should have
list python dependencies needed for documentation in
doc/requirements.txt which are move from test-requirements.txt
[doc/source/contributor/index.rst] & [setup.cfg]
- Remove [pbr] section in setup.cfg [3], and unrelated lines in
contributor/index.rst
[3] http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html
- Add sphinxcontrib.apidoc to replace pbr autodoc
[tox.ini]
--ignore D000: pep8 require sphinx (which move to doc/requirements.txt)
to test doc/source files, however, docs already test the doc/source.
Therefore we can ignore the D000 error code.
Depends-On: https://review.openstack.org/#/c/559327/
Change-Id: Iee90f19a5e46978a97035eab7e4b1e0ec68b8684
Diffstat (limited to 'setup.cfg')
-rw-r--r-- | setup.cfg | 14 |
1 files changed, 0 insertions, 14 deletions
@@ -189,20 +189,6 @@ ironic.hardware.types = ironic.database.migration_backend = sqlalchemy = ironic.db.sqlalchemy.migration -[pbr] -autodoc_index_modules = True -autodoc_exclude_modules = - ironic.db.sqlalchemy.alembic.env - ironic.db.sqlalchemy.alembic.versions.* - ironic.drivers.modules.ansible.playbooks* -api_doc_dir = contributor/api - -[build_sphinx] -all_files = 1 -build-dir = doc/build -source-dir = doc/source -warning-is-error = 1 - [egg_info] tag_build = tag_date = 0 |