summaryrefslogtreecommitdiff
path: root/doc/source/_exts
Commit message (Collapse)AuthorAgeFilesLines
* Create API documentation from docstringsMahnoor Asghar2022-03-171-0/+346
| | | | | | | | | | 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
* Doc building: Silence automated_stepsAndreas Jaeger2020-05-141-4/+8
| | | | | | | The logs of docs for this repo are really large, silence a small part: The logging of automated steps debug output. Change-Id: I3f7991a79bf89f04932bb4501c3f39d0317414e5
* Skip clean steps from 'fake' interfaces in the documentationDmitry Tantsur2020-03-111-0/+3
| | | | | | | They are not targeted at operators, and the title 'fake cleaning steps' is confusing. Change-Id: Ibe42ede09fcbc5d8c16c8b1996f6c4055ad6a138
* Disable debug output in doc buildingAndreas Jaeger2020-02-061-1/+1
| | | | | | | Disable the debug output, we don't need 10s of lines to display the RST file during normal builds. Change-Id: I3c53ca2591d92e3354efb9da99cf2ee19ea51b7d
* add table of available cleaning steps to documentationDoug Hellmann2019-08-301-0/+187
The documentation currently has no information at all about what steps are available *generally* for automated or manual cleaning. Users who want to find this information must review the source code themselves, except in one or two cases where driver-specific documentation has the details spelled out. This patch adds a series of tables to the general cleaning documentation to provide details about the steps one could possibly add to the instructions given to ironic, along with details about required parameters and what the effect of each step will be. Change-Id: I6b225cce38b815248c457814508531041c437e6d Signed-off-by: Doug Hellmann <doug@doughellmann.com>