How would you describe the priority of this documentation request
High
Describe the future/missing documentation
We have markdown documentation that exists in the examples/ and models/ directories.
These are included in our documentation builds under docs/source via symlinks.
The issue arises if we need to create a relative link to documentation which is then broken in the build.
Ex:
Creating a link to docs/source/developer_guide/contributing.md within examples/README.md could be done with ../docs/source/developer_guide/contributing.md but this breaks in the documentation build.
Ideally a sphyinx plugin for something like this already exists.
Where have you looked?
No response
Code of Conduct
[X] I agree to follow this project's Code of Conduct
How would you describe the priority of this documentation request
High
Describe the future/missing documentation
We have markdown documentation that exists in the
examples/
andmodels/
directories.These are included in our documentation builds under
docs/source
via symlinks.The issue arises if we need to create a relative link to documentation which is then broken in the build.
Ex: Creating a link to
docs/source/developer_guide/contributing.md
withinexamples/README.md
could be done with../docs/source/developer_guide/contributing.md
but this breaks in the documentation build.Ideally a sphyinx plugin for something like this already exists.
Where have you looked?
No response
Code of Conduct