Details
-
Type:
Story
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: None
-
Labels:None
-
Story Points:2.4
-
Epic Link:
-
Team:SQuaRE
-
Urgent?:No
Description
In DM-36085 and DM-36117 we introduced the documenteer.toml file to make it easier to set up a Sphinx-based user guide that builds on our built in configuration presets, documenteer.conf.guide. A user can always dive into Sphinx configurations directly by futher customizing the standard Sphinx conf.py file, but this is a tricky process — especially if we already ship presets that configure those aspects. This ticket is to support configuring some of the most common Sphinx configuration scenarios for users via documenteer.toml:
- intersphinx_mapping
- nitpick_ignore
- linkcheck_ignore
- extensions
This feature is now part of documenteer 0.7.0b1. Next we'll apply the new Documenteer user guide configuration presets to Safir, another big SQuaRE software project with a substantial user guide.