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

Module links do not work if no-main-docstr used

    Details

    • Team:
      SQuaRE

      Description

      The style guide (e.g., https://developer.lsst.io/restructuredtext/style.html) recommends using `lsst.module` or :py:mod:`lsst.module` to link to the documentation of Python modules. However, if the corresponding automodapi has the :no-main-docstr: option (which is also recommended), the links will not resolve (they look exactly like a link to a nonexistent class).

      I propose either restoring link functionality or removing the inconsistency from the style guide. In the meantime, the issue can be worked around using a normal link to the module home page.

        Attachments

          Activity

          There are no comments yet on this issue.

            People

            • Assignee:
              jsick Jonathan Sick
              Reporter:
              krzys Krzysztof Findeisen
              Watchers:
              Krzysztof Findeisen
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:

                Summary Panel