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

Documenteer: Refine user guide configuration and documenteer.toml

    XMLWordPrintable

    Details

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

      Description

      Based on the experience in implementing the new user guide theme in both Safir and in Documenteer itself, I've identified some additional configuration features that will make this theme better and easier to integrate in more projects:

      • Support "Edit on GitHub"
      • Support changing directory where Python API is generated in documenteer.toml
      • Support setting which pages shouldn't have a primary sidebar from documenteer.toml.
      • Enable the copy button on code blocks
      • Support changing the number of items in the nav bar before the "More" link in documenteer.toml.

        Attachments

          Activity

          Hide
          jsick Jonathan Sick added a comment -

          PR in https://github.com/lsst-sqre/documenteer/pull/135 and released in documenteer 0.7.0b3

          Show
          jsick Jonathan Sick added a comment - PR in https://github.com/lsst-sqre/documenteer/pull/135 and released in documenteer 0.7.0b3

            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.