-
Notifications
You must be signed in to change notification settings - Fork 272
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
Use more Sphinx directives. #282
Comments
glossary and term seem interesting. I do not think we need section author. Not sure what file will do/how it changes what end users see. When do you think we would use kbd over tick marks? |
section author, I'm guessing no because we have git already? |
Oh... I see now about kbd. Seems cool. I am not sure where we would use file because hopefully the documents are becoming year agnostic. Yup. Section authors are redundant with git. |
Looks like better formatting for the kbd directive will be in the next RTD theme release. readthedocs/sphinx_rtd_theme#677 |
Closing as it's not really an issue, and we are using glossary. Something to keep in mind going forward |
This is a list of a few Sphinx directives that I think might be useful to add (if not just because Sphinx provides them), sorted in roughly "wantedness":
.. glossary
/:term:
Allows to create a glossary of terms. This would be quite useful, especially in more complex sections.
.. sectionauthor
Specifies who wrote the majority of the current section. Useful for when clarification is needed.
Might be a pain if only one author is allowed.
Does not by default get rendered in output.
:file:
Used for naming files. Apparently this looks different?
:kbd:
Used to represent keyboard strokes. This uses the HTML tag
<kbd>
and hence draws a box around the key.The text was updated successfully, but these errors were encountered: