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

Update documenteer's doxygen configuration to encompass base configs

    XMLWordPrintable

    Details

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

      Description

      In DM-22698, DM-23094, and DM-22461 we incorporated Doxygen builds for Pipelines docs directly into Documenteer, migrating away from our dependency on sconsUtils and lsstDoxygen. This included consolidating the Doxygen configuration, while still allowing individual packages a limited vocabulary of Doxygen configuration tags to include or exclude specific paths from the documentation.

      We've discovered, though, that the base package actually plays a special role in providing configuration defaults beyond those coded into sconsUtils.

      Thus in this ticket we will port base's configurations into documenteer and expand documenteer's Doxygen configuration facility to handle these new tags.

        Attachments

          Issue Links

          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-22461 Create Sphinx "autocppapi" extension in Documenteer

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-22698 Run stack-wide Doxygen builds from Documenteer, replacing makeDocs and create_xlinkdocs.sh

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-23094 Implement C++ reference documentation for pipelines.lsst.io using "Doxylink"

          • Done

            Activity

            Ascending order - Click to sort in descending order
            No builds found.
            jsick Jonathan Sick created issue -
            jsick Jonathan Sick made changes -
            Field Original Value New Value
            Epic Link DM-25248 [ 435569 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-22461 [ DM-22461 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-23094 [ DM-23094 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-22698 [ DM-22698 ]
            jsick Jonathan Sick made changes -
            Status To Do [ 10001 ] In Progress [ 3 ]
            jsick Jonathan Sick made changes -
            Component/s documenteer [ 16000 ]
            jsick Jonathan Sick made changes -
            Story Points 7.7
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            1. Port the `base.inc`, `pex_config.inc` and `pex_exceptions.inc` files from their respective packages into a Doxygen default configuration that's included with Documenteer and included in the Doxygen config via `@INCLUDE_PATH` and `@INCLUDE` Doxygen configuration tags.

            2. Embed the Doxygen tag file for cppreference.com, which was previously stored in the base package as well.

            3. Add `IMAGE_PATH` Doxygen configuration and make it something that can be set from individual packages.

            4. Include `src/` directories and `.cc` files in Doxygen inputs as that matches existing usage.

            5. Add Doxygen logging configurations to DoxygenConfiguration to enable future dynamic settings.

            The net effect is that the Doxygen builds controlled by Documenteer now match the functionality of `sconsUtils`, `lsstDoxygen`, etc. in terms of fully reproducing the `lsst` namespace.

            Show
            jsick Jonathan Sick added a comment - 1. Port the `base.inc`, `pex_config.inc` and `pex_exceptions.inc` files from their respective packages into a Doxygen default configuration that's included with Documenteer and included in the Doxygen config via `@INCLUDE_PATH` and `@INCLUDE` Doxygen configuration tags. 2. Embed the Doxygen tag file for cppreference.com, which was previously stored in the base package as well. 3. Add `IMAGE_PATH` Doxygen configuration and make it something that can be set from individual packages. 4. Include `src/` directories and `.cc` files in Doxygen inputs as that matches existing usage. 5. Add Doxygen logging configurations to DoxygenConfiguration to enable future dynamic settings. The net effect is that the Doxygen builds controlled by Documenteer now match the functionality of `sconsUtils`, `lsstDoxygen`, etc. in terms of fully reproducing the `lsst` namespace.
            jsick Jonathan Sick made changes -
            Resolution Done [ 10000 ]
            Status In Progress [ 3 ] Done [ 10002 ]

              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.