Skip to content

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

Description

@yousefmoazzam

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationquestionFurther information is requested

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions