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

Documentation subproject cross-referencing needs to be more sophisticated #3289

Open
stichbury opened this issue Nov 8, 2023 · 1 comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@stichbury
Copy link
Contributor

Description

At present, it's not possible to cross reference between subprojects if you need to include a permalink to a subhead.

So it's fine to link to a page:

By convention, a {doc}`pipeline can be defined as having different layers<kedro:resources/glossary>`. 

But not to a header on a page.

By convention, a {doc}`pipeline can be defined as having different layers<kedro:resources/glossary#data-layers>`. 

@astrojuanlu has diagnosed this as resulting from the fact there's no explicit label defined for a section, so Sphinx didn't generate a std:label anchor to it and what you're trying to do won't work.

He says that the way to fix that would be to change the Kedro docs themselves by either:

For now, I'm retaining the hard-coded link old-school style but this should be fixed in due course.

@astrojuanlu
Copy link
Member

This is still a priority, but I'm releasing @stichbury from doing it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
None yet
Development

No branches or pull requests

2 participants