Cross-referencing
See original GitHub issueThanks for writing this extension!
Considering the following setup:
.. click:: test:hello
:prog: test
:show-nested:
It would be nice if one can refer to the resulting documentation (e.g. for one of the nested commands) just as one can reference normal functions via the directives documented in http://www.sphinx-doc.org/en/stable/domains.html#cross-referencing-python-objects .
I.e. it would be nice if something like :py:click-command:'test.hello'
would insert a link to the relevant part of the documentation.
Issue Analytics
- State:
- Created 6 years ago
- Comments:12 (5 by maintainers)
Top Results From Across the Web
Cross-reference - Wikipedia
In programming, "cross-referencing" means the listing of every file name and line number where a given named identifier occurs within the program's source...
Read more >Cross-reference Definition & Meaning - Merriam-Webster
The meaning of CROSS-REFERENCE is a notation or direction at one place (as in a book or filing system) to pertinent information at...
Read more >Create a cross-reference - Microsoft Support
A cross-reference allows you to link to other parts of the same document. For example, you might use a cross-reference to link to...
Read more >Cross-reference definition and meaning | Collins English ...
A cross-reference is a note in a book which tells you that there is relevant or more detailed information in another part of...
Read more >Cross-referencing | Journals | Oxford Academic
Cross -referencing is a powerful tool that can greatly enhance your work. Good cross-referencing allows readers to link quickly to related material elsewhere ......
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
The oslo.config and oslo.policy projects from Openstack both provide custom domains with directives and roles that should be pretty easy to understand. Look for the
sphinxext
module in bothI suspect it should be a new, custom domain. The Sphinx docs provide examples of how to do this if you haven’t done so before. We’ll want a custom domain, at least three custom directives (
command
,option
andenvvar
?) and matching roles for each. There’s no reason we couldn’t emit both the “legacy” sphinx-native stuff and new custom stuff, though I’d have no issue with a global toggle to switch this behaviour. If you can get a PoC, I’m happy to review and provide feedback. I’m also willing to be talked around on any of the above!