Description
Description of the modifications
The pyvista_example.py file in C:\AnsysDev\GitRepos\PyAnsys\dev-guide\examples is not included in a toctree. It is referenced in the last paragraph in the "Examples" topic on the Documenting page and in the first bullet in the "Set up examples" topic on the Use Sphinx-Gallery page. It shows up in the breadcrumb trail like this:
The breadcrumb for the link from the Documenting page looks like this:
The breadcrumb for the link from the Use Sphinx-Gallery page looks like this:
Sphinx doesn't complain about this because the source file is located outside of the doc directory. We need to decide where to put the example content so that it's part of a toctree. It can be part of the "How-To>Documenting" section or Content writing>Content in examples section. Information about examples can then be consolidating in the decided location.
Useful links and references
https://dev.docs.pyansys.com/how-to/documenting.html
https://dev.docs.pyansys.com/content-writing/examples-writers/sphinx-gallery.html