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

Create a fenced code snippet Sphinx extension

    Details

    • Team:
      SQuaRE

      Description

      A reST directive for Sphinx that shows (and highlights) source code from an external source code file. The snippet can be either the whole file, or more particularly, just part of the file. Named fences defined in the source code's comments can be used to extract a source code snippet. (Comment fences are better than specifying line number ranges since line numbers change too frequently).

      Source code could be specified multiple ways

      • Filesystem path
      • Remote git path + branch + file path
      • Python namespace path

      Part of lsst_sphinx_kit

        Attachments

          Issue Links

            Activity

            There are no comments yet on this issue.

              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:

                  Summary Panel