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

Documenteer: Support reading the Sphinx rst_epilog configuration from a file

    XMLWordPrintable

    Details

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

      Description

      We use the Sphinx rst_epilog configuration to set links and substitutions for a documentation project that can be reused across all of a project's rst pages. At the moment, these substitutions are coded as a Python string in the Sphinx conf.py. Given DM-36085's push to limit how much we need to use and configure conf.py, it makes sense to extract rst_epilog into a pure-reStructuredText configuration file that is automatically read by the documenteer.conf.guide configuration preset (if avaialable).

      I suggest using _rst_epilog.rst as the file name (or potentially make is configurable via documenteer.toml. This file should be automatically added to Sphinx's source ignore list to avoid creating a page with the same name.

        Attachments

          Issue Links

            Activity

            Hide
            jsick Jonathan Sick added a comment -

            Implemented this feature in https://github.com/lsst-sqre/documenteer/pull/132 and it'll become available in documenteer 0.7. I'm using it in documenteer's own docs, so all links and substitutions are shared across all pages now.

            Show
            jsick Jonathan Sick added a comment - Implemented this feature in https://github.com/lsst-sqre/documenteer/pull/132 and it'll become available in documenteer 0.7. I'm using it in documenteer's own docs, so all links and substitutions are shared across all pages now.

              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.