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

Create remote-code-block Sphinx directive

    XMLWordPrintable

    Details

      Description

      Create a remote-code-block Sphinx directive that mirrors how literal-include works, but permits a URL so that the content is downloaded from an external https URL.

      Caching should be included so that docs can be built offline. The intersphinx extension might be a good guide for how to implement caching.

      This directive is needed to feature content from https://github.com/lsst/templates in documentation projects like the Developer Guide.

        Attachments

          Issue Links

            Activity

            Show
            jsick Jonathan Sick added a comment - Docs for literalinclude http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-literalinclude
            Show
            jsick Jonathan Sick added a comment - Implementation of intersphinx: https://github.com/sphinx-doc/sphinx/blob/master/sphinx/ext/intersphinx.py Implementation of literalinclude : https://github.com/sphinx-doc/sphinx/blob/72e60ce1653c7f03c1d4519424dbb8391c2ecbd1/sphinx/directives/code.py
            Hide
            jsick Jonathan Sick added a comment -

            This work is deployed with documenteer 0.3.0a4.

            Show
            jsick Jonathan Sick added a comment - This work is deployed with documenteer 0.3.0a4.

              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.