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.
(windio) >>mbp@~/Development/windIO/docs (docs/yaml_include_errors *)$ make clean
Removing everything under '_build'...
(windio) >>mbp@~/Development/windIO/docs (docs/yaml_include_errors *)$ make html
Running Sphinx v7.2.6
making output directory... done
WARNING: html_static_path entry '_static' does not exist
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 18 source files that are out of date
updating environment: [new config] 18 added, 0 changed, 0 removed
reading sources... [100%] source/wind_farm
/Users/rmudafor/Development/windIO/docs/source/blade.rst:121: WARNING: start-after pattern not found: # Layer 1
/Users/rmudafor/Development/windIO/docs/source/blade.rst:127: WARNING: start-after pattern not found: # Layer 3
/Users/rmudafor/Development/windIO/docs/source/blade.rst:142: WARNING: start-after pattern not found: # Layer 4
/Users/rmudafor/Development/windIO/docs/source/blade.rst:156: WARNING: start-after pattern not found: # Web layer
/Users/rmudafor/Development/windIO/docs/source/control.rst:10: WARNING: start-after pattern not found: # Actuators
/Users/rmudafor/Development/windIO/docs/source/control.rst:130: WARNING: duplicate label pitch, other instance in /Users/rmudafor/Development/windIO/docs/source/control.rst
/Users/rmudafor/Development/windIO/docs/source/floating.rst:83: WARNING: end-before pattern not found: # Rigid
/Users/rmudafor/Development/windIO/docs/source/floating.rst:249: WARNING: start-after pattern not found: # Rigid
/Users/rmudafor/Development/windIO/docs/source/plant_energy_site.rst:17: WARNING: duplicate label properties, other instance in /Users/rmudafor/Development/windIO/docs/source/plant_energy_resource.rst
/Users/rmudafor/Development/windIO/docs/source/plant_energy_site.rst:51: WARNING: duplicate label examples, other instance in /Users/rmudafor/Development/windIO/docs/source/plant_energy_resource.rst
/Users/rmudafor/Development/windIO/docs/source/support.rst:21: WARNING: end-before pattern not found: # Foundation
/Users/rmudafor/Development/windIO/docs/source/support.rst:30: WARNING: start-after pattern not found: # Foundation
/Users/rmudafor/Development/windIO/docs/source/turbine.rst:6: WARNING: start-after pattern not found: # Top level entries of the IEA Wind Task 37 wind turbine ontology
/Users/rmudafor/Development/windIO/docs/source/wind_energy_system.rst:15: WARNING: duplicate label properties, other instance in /Users/rmudafor/Development/windIO/docs/source/plant_energy_site.rst
/Users/rmudafor/Development/windIO/docs/source/wind_energy_system.rst:35: WARNING: duplicate label examples, other instance in /Users/rmudafor/Development/windIO/docs/source/plant_energy_site.rst
/Users/rmudafor/Development/windIO/docs/source/wind_farm.rst:15: WARNING: duplicate label properties, other instance in /Users/rmudafor/Development/windIO/docs/source/wind_energy_system.rst
/Users/rmudafor/Development/windIO/docs/source/wind_farm.rst:84: WARNING: duplicate label examples, other instance in /Users/rmudafor/Development/windIO/docs/source/wind_energy_system.rst
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets... copying static files... done
copying extra files... done
done
writing output... [100%] source/wind_farm
generating indices... genindex done
writing additional pages... search done
copying images... [100%] source/images/stiffenerZoom.png
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 18 warnings.
The HTML pages are in _build/html.
@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.
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
literalincludethat 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.