-
Notifications
You must be signed in to change notification settings - Fork 50
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
doc: audit man page cross references #4003
Comments
i like the idea that RESOURCES should just point to web addresses, while SEE ALSO just points to other manpages. |
while i'm at it, the web addresses are listed inconsistently. I think I would prefer just doing a format like:
where as we sometimes do:
While this gets you a pretty link in read the docs, the manpage gets you this relatively useless:
just the name for the URL and nothing else. But doing
|
I'm definitely not a sphinx/reStructuredText expert, but maybe with intersphinx and specific domains, we can do a little better than either of the approaches above. The manpage domainrefs plugin I just added might help here, for example see how mitogen uses it to add other general web refs in their conf.py: https://github.com/mitogen-hq/mitogen/blob/master/docs/conf.py |
closed via #4007 |
Once the macro for conveniently adding manual page cross-references in #3999 is merged, we may want to audit the SEE ALSO sections of our man pages. Cross references appear to be hit and miss.
Also, some SEE ALSO references are web references. Should we move those to RESOURCES and reserve SEE ALSO for man page cross-references?
While we're at it, we should consider updating the github organization link in RESOURCES since we have other, better documentation resources now. Maybe just change it to https://flux-framework.org/, which is the most "meta" reference we have.
The text was updated successfully, but these errors were encountered: