Fix errors when including turbine input file structure in docs #25
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Sphinx-based documentation is not currently including the turbine YAML input file snippets due to incorrect references to the example files. A few of the pages in the docs reference
test/turbine/turbine_example.yaml
, but the two test-files for the turbine ontology included in the repository are at:This pull request fixes the referenced file paths and suggests fixes for starting and stopping points for the included sections.
There are still some remaining errors, as shown below, since a few sections reference start and end points in the
literalinclude
that aren't found in the input file.@ptrbortolotti I tried to make a reasonable guess at the sections that are meant to be referenced, but you may want to review this in detail since I'm not familiar with the turbine ontology.