Revise "reStructuredText Directives" plus small documentation updates.
commit98183f777c4faf48fe17196be615c5907de726e6
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>
Fri, 8 Mar 2024 23:41:22 +0000 (8 23:41 +0000)
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>
Fri, 8 Mar 2024 23:41:22 +0000 (8 23:41 +0000)
treefc97e701e9804306d37c804b95325ac6fc99acc5
parent8f86dcba70bf4f4528db5f77b7713db8bbf99289
Revise "reStructuredText Directives" plus small documentation updates.

Update HISTORY.
Small additions for "The Docutils Document Tree".
Fix option name and link in "Docutils Configuration".
Adapt link in "reStructuredText Interpreted Text Roles".

"reStructuredText Directives":
 * Sort option lists by name.
 * Use ``literal`` for directive option names
   (except when the name is also a hyperlink).
 * Provide more cross-links.
 * Repeat option name in introduction sentence to the option list.
 * Use space (instead of hyphen) in ``_class option:`` hyperlink target
   (no change to the generated id).
 * Shorten descriptions if possible without loss of clarity.

git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@9551 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
docutils/HISTORY.txt
docutils/docs/ref/doctree.txt
docutils/docs/ref/rst/directives.txt
docutils/docs/ref/rst/roles.txt
docutils/docs/user/config.txt