docs: remove config doc dependency on tables/*.inc files
Bug #1847600 reported by
do3meli
This bug affects 1 person
| Affects | Status | Importance | Assigned to | Milestone | |
|---|---|---|---|---|---|
| Cinder |
In Progress
|
Low
|
Unassigned | ||
Bug Description
currently the cinder configuration documentation is not really generated from the code (at least not everywhere). Any documentation for options/parameters should be generated from the code with the help of sphinx.
the current existing files were one time generated by an old and obsolete tool. This is in particular the case for files in doc/source/
this bug should be some kind of an umbrella bug for driver maintainers that adopt this.
| summary: |
- cinder configuration doc should be more auto generated + docs: remove config doc dependency on tables/*.inc files |
| Changed in cinder: | |
| status: | New → Triaged |
| importance: | Undecided → Low |
Revision history for this message
| Brian Rosmaita (brian-rosmaita) wrote | #1 |
Revision history for this message
| OpenStack Infra (hudson-openstack) wrote Fix proposed to cinder (master) | #2 |
| Changed in cinder: | |
| status: | Triaged → In Progress |
To post a comment you must log in.
A bit more info for anyone interested in looking into this:
A lot of the driver docs use the sphinx config-table directive to pull the info directly from where the config opts are defined in the code. See, for example, doc/source/
The HPE 3PAR Fibre Channel and iSCSI drivers are now enabled on your
OpenStack system. If you experience problems, review the Block Storage
service log files for errors.
The following table contains all the configuration options supported by
the HPE 3PAR Fibre Channel and iSCSI drivers.
.. config-table::
:config-
cinder.
So the idea is to try to use the config-table directive (which would generate the table automatically) instead of the tables/*.inc files (which have to be maintained by hand).