diff options
| author | Mahnoor Asghar <masghar.bese15seecs@seecs.edu.pk> | 2022-02-01 05:12:37 +0500 |
|---|---|---|
| committer | Mahnoor Asghar <masghar.bese15seecs@seecs.edu.pk> | 2022-03-17 01:22:44 +0500 |
| commit | 3e631a5931c9a3d53d78438339adfeeae5fa5a70 (patch) | |
| tree | f584f2f34b03f17297b655e27d8c30a6c1a0b11c /tox.ini | |
| parent | 365a4545fe6606b1fda8f1387e851641de25cec8 (diff) | |
| download | ironic-3e631a5931c9a3d53d78438339adfeeae5fa5a70.tar.gz | |
Create API documentation from docstrings
Create a new Sphinx extension called 'web_api_docstring' to process
docstrings from the API classes, in order to generate API
documentation.
Story: 2009785
Task: 44291
Change-Id: Ia6b2b3741e2b1cbd29531c21795df4f0f0dc70ca
Diffstat (limited to 'tox.ini')
| -rw-r--r-- | tox.ini | 2 |
1 files changed, 2 insertions, 0 deletions
@@ -92,9 +92,11 @@ commands = [testenv:api-ref] +# NOTE(Mahnoor): documentation building process requires importing ironic API modules usedevelop = False deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master} + -r{toxinidir}/requirements.txt -r{toxinidir}/doc/requirements.txt allowlist_externals = bash commands = |