Resolve "Reformat config file parameter docs into list/objects"
What does this MR do?
Adopt Python RST writer to write single RST objects per parameter instead of merging all parameters of one category into a list.
Additionally, add a Sphinx config variable triggering on the environment variable This did not work out. However, the online links do not result in a 404 error but simply do nothing when clicked on. I guess this is fine.DOC_DEPLOY_ONLINE. This will lead to a warning on dead links appearing in the config file parameter cheat sheet.
Is there something that needs to be double checked?
- Sphinx compiles RST source without warnings
[ ] Warning on dead links appears in config file manual
Can this MR be accepted?
- Implemented changes to RST writer
[ ] Added/Updated tests- Added/Updated documentation of Python module
- Pipeline passing
- Squash option set
- Delete branch option set
-
Added entry to
CHANGELOG.md
Related issues
Closes #165 (closed)