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

Fix html_extra_path configuration for pipelines documentation configuration in Documenteer

    XMLWordPrintable

    Details

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

      Description

      Documenteer pipelines configuration bug reported via Slack on Saturday 2021-04-24:

      The documenteer documentation in https://documenteer.lsst.io/pipelines/configuration.html has this as part of the default configuration:

      1. Add any extra paths that contain custom files (such as robots.txt or
      2. .htaccess) here, relative to this directory. These files are copied
      3. directly to the root of the documentation.
        html_extra_path = []
        if os.path.exists("_doxygen/html"):
        html_extra_path.append("_doxygen/html")
        but I'm not seeing that happen in a stack-docs build; _doxygen/html exists, but its contents are not present in _build/html.  What am I doing wrong?
         
         
        11:17
        Oh: is it because of
        html_extra_path = [""]
        further down?
         

        Kian-Tat Lim  11:56 AM

      Yup, looks like replacing that in conf.py copies the doxygen.  There are no links to it, though, and many of the package pages are missing...

        Attachments

          Activity

          Ascending order - Click to sort in descending order
          Hide
          Permalink
          jsick Jonathan Sick added a comment -

          I've release documenteer 0.6.7 to PyPI:

           

          Fixes:

          • The html_extras_path is no longer accidentally reset to [""] in documenteer.conf.pipelines.
          • sphinx-automodapi introduces an autodoc enhancement that replace’s autodoc’s attr getter for type with a custom function. However, we’re finding that this enhancement is incompatible with Pybind11 static properties that are part of the LSST Science Pipelines API. This release includes a new extension, documenteer.ext.autodocreset, that resets the attr getter for type to the one built into autodoc. This extension is used by default in documenteer.config.pipelines and documenteer.config.pipelinespkg.

           

          Overall this release includes incorporates fixes we've needed to make to the conf.py file of pipelines_lsst_io }}but moves them back to{{ documenteer.config.pipelines. I'm waiting on conda-forge to finalize the release.

          Show
          jsick Jonathan Sick added a comment - I've release documenteer 0.6.7 to PyPI:   Fixes: The html_extras_path is no longer accidentally reset to [""] in documenteer.conf.pipelines . sphinx-automodapi introduces an autodoc enhancement that replace’s autodoc’s attr getter for type with a custom function. However, we’re finding that this enhancement is incompatible with Pybind11 static properties that are part of the LSST Science Pipelines API. This release includes a new extension, documenteer.ext.autodocreset , that resets the attr getter for type to the one built into autodoc. This extension is used by default in documenteer.config.pipelines and documenteer.config.pipelinespkg .   Overall this release includes incorporates fixes we've needed to make to the conf.py file of  pipelines_lsst_io }}but moves them back to{{ documenteer.config.pipelines. I'm waiting on conda-forge to finalize the release.
          Hide
          Permalink
          jsick Jonathan Sick added a comment -

          The conda-forge PR passed and merged: https://github.com/conda-forge/lsst-documenteer-feedstock/pull/13

          documenteer 0.6.7 should be available soon on conda-forge.

          Show
          jsick Jonathan Sick added a comment - The conda-forge PR passed and merged: https://github.com/conda-forge/lsst-documenteer-feedstock/pull/13 documenteer 0.6.7 should be available soon on conda-forge.

            People

            Assignee:
            jsick Jonathan Sick
            Reporter:
            jsick Jonathan Sick
            Watchers:
            Jonathan Sick, Kian-Tat Lim
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Jenkins

                No builds found.