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

Authoring: Add primer about linking and (cross-) referencing with Sphinx #468

Merged
merged 3 commits into from
Mar 4, 2024

Conversation

amotl
Copy link
Member

@amotl amotl commented Mar 1, 2024

Problem

There hasn't been a clear guide how to define and use the various ways of linking and referencing when writing documentation with Sphinx.

Solution

Now that the system supports both reStructuredText and Markdown, there should be a dedicated page exploring and illustrating all the variants concisely but extensively.

Preview

https://crate-docs-theme--468.org.readthedocs.build/en/468/links.html

Details

This partly builds upon those blocks. When authoring documents, and needing to run links to other parts of the documentation, it is particularly important to be able to quickly find out about available link target labels.

Q&A

Please advise and add any question about linking and referencing in Sphinx you never dared to ask, or add any kind of suggestion where you think we should improve this page. The right time for that is now ;].

/cc @WalBeh, @karynzv, @surister, @wierdvanderhaar

@amotl amotl requested review from msbt and matkuliak March 1, 2024 20:55
@amotl amotl marked this pull request as ready for review March 1, 2024 20:57
@amotl amotl changed the title Add primer about linking and (cross-) referencing with Sphinx Developer Docs: Add primer about linking and (cross-) referencing with Sphinx Mar 2, 2024
@amotl amotl changed the title Developer Docs: Add primer about linking and (cross-) referencing with Sphinx Authoring Docs: Add primer about linking and (cross-) referencing with Sphinx Mar 2, 2024
@amotl amotl changed the title Authoring Docs: Add primer about linking and (cross-) referencing with Sphinx Authoring: Add primer about linking and (cross-) referencing with Sphinx Mar 2, 2024
@amotl amotl merged commit b0159ea into main Mar 4, 2024
8 checks passed
@amotl amotl deleted the amo/crossref branch March 4, 2024 10:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants