DiamondLightSource / DiamondLightSource/httomo-backends

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

Open
#9 0 comments 0 reactions 0 assignees View on GitHub
documentation question
Dominant language
Python
Stars
0
Forks
1
PR merge metrics
No merged PRs in 30d

Description

The use of the reference `:backends_content` in this line: https://github.com/DiamondLightSource/httomo-backends/blob/a34bf5802fc541ef5a0c541377b000ce596882aa/docs/source/utilities/yaml_generator.rst?plain=1#L5

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](https://github.com/user-attachments/assets/700259b5-4011-484b-befc-b8fa50fdd46c)

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`: https://github.com/DiamondLightSource/httomo-backends/blob/a34bf5802fc541ef5a0c541377b000ce596882aa/docs/source/index.rst?plain=1#L3-L9

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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.