Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Possibly incorrect link to main page from "Templates generator"? #9

Open
yousefmoazzam opened this issue Oct 28, 2024 · 0 comments
Open
Labels
documentation Improvements or additions to documentation question Further information is requested

Comments

@yousefmoazzam
Copy link
Contributor

The use of the reference :backends_content in this line:

:ref:`backends_content` can be generated automatically using the YAML generator tool `provided <https://github.com/DiamondLightSource/httomo/tree/main/scripts/yaml_templates_generator.py>`_ in the Github repo.

appears to be wanting to link to the YAML templates that have been generated.

However, while the text of the link is what is expected for a link to YAML templates:
templates-generator-link

it actually links to the main page, which doesn't seem like what would be intended?

The linking to the main page is likely due to the reference being put in index.rst:

.. _backends_content:
.. toctree::
:caption: YAML Templates
:maxdepth: 2
backends/templates

and should instead be moved to somewhere in the templates.rst file.

@yousefmoazzam yousefmoazzam added documentation Improvements or additions to documentation question Further information is requested labels Oct 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant