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

Documenteer: update config to omit conf.py and other meta artifacts from html output

    XMLWordPrintable

Details

    • Story
    • Status: Done
    • Resolution: Done
    • None
    • documenteer
    • None

    Description

      There's evidence that these files are being included in the HTML output for package documentation. This is presenting unexpected issues for linters (flake8 might lint the conf.py in the build output). It's also something we'd rather not upload in the first place.

      As well, it seems that .doctree and the Doxygen html/xml directories are being uploaded.

      This ticket is to update the Documenteer configuration so that these types of files are excluded from the built site.

      Attachments

        Issue Links

          Activity

            Released as documenteer 0.6.8 on PyPI. Conda-forge build failed due to a Sphinx 4 incompatibility; see DM-30115 for the fix.

            jsick Jonathan Sick added a comment - Released as documenteer 0.6.8 on PyPI. Conda-forge build failed due to a Sphinx 4 incompatibility; see DM-30115 for the fix.

            People

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

              Dates

                Created:
                Updated:
                Resolved:

                Jenkins

                  No builds found.