Details
-
Type:
Story
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: Stack Documentation and UX
-
Labels:
-
Story Points:1.2
-
Epic Link:
-
Team:SQuaRE
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
- has to be done before
-
DM-14782 Switch to sphinx-automodapi package
- Done
Docs for literalinclude http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-literalinclude