Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-36137

Documenteer: Support documenteer.toml configs for extensions, intersphinx, and nitpick ignore

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None

      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

        Attachments

          Activity

          Hide
          jsick Jonathan Sick added a comment -

          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.

          Show
          jsick Jonathan Sick added a comment - 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.

            People

            Assignee:
            jsick Jonathan Sick
            Reporter:
            jsick Jonathan Sick
            Watchers:
            Jonathan Sick
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Jenkins

                No builds found.