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

Support external code examples in stack-docs

    Details

    • Type: Story
    • Status: To Do
    • Resolution: Unresolved
    • Fix Version/s: None
    • Component/s: documenteer
    • Labels:
      None
    • Templates:
    • Team:
      SQuaRE

      Description

      Some Stack documentation, particularly in afw, has tutorials that include code from a real file, typically from the examples directory. This can be represented in RST as:

      .. literalinclude:: ../../examples/statistics.cc
         :language: cpp
      

      but this only works in package-level docs. It might be useful to add support for literalinclude:: to the stack-docs tool.

      Alternatively, we could require that authors only use code-block:: for source code examples.

        Attachments

          Container Issues

            Issue Links

              Activity

                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