summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2022-11-28 23:55:35 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2022-11-28 23:55:35 +0000
commit6925304d7a5cba5c6d12150180287a6a4bf3e149 (patch)
tree53de506fc8b6148d70f6b9ddbaef87ae3c82ed27
parentf830c95737139e6f200624774ff453492de78278 (diff)
downloaddocutils-6925304d7a5cba5c6d12150180287a6a4bf3e149.tar.gz
Small documentation fixes and updates.
git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9281 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
-rw-r--r--docutils/docs/dev/testing.txt10
-rw-r--r--docutils/docs/index.txt77
-rw-r--r--docutils/docs/user/config.txt2
-rw-r--r--web/index.txt2
4 files changed, 48 insertions, 43 deletions
diff --git a/docutils/docs/dev/testing.txt b/docutils/docs/dev/testing.txt
index 0a3d86655..eb7426f8f 100644
--- a/docutils/docs/dev/testing.txt
+++ b/docutils/docs/dev/testing.txt
@@ -84,23 +84,23 @@ get multiple Python versions::
pyenv install 3.7.12
pyenv install 3.8.12
pyenv install 3.10.1
- pyenv global system 3.7.12 3.8.12 3.10.1
+ pyenv global system 3.7.12 3.8.12 3.10.1 3.11.0
# reset your shims
rm -rf ~/.pyenv/shims && pyenv rehash
-This will give you ``python3.7`` through ``python3.10``.
+This will give you ``python3.7`` through ``python3.11``.
Then run::
python3.7 -u alltests.py
[...]
- python3.10 -u alltests.py
+ python3.11 -u alltests.py
.. [#] Good resources covering the differences between Python versions
- are the `What's New` documents (`What's New in Python 3.10`__ and
+ are the `What's New` documents (`What's New in Python 3.11`__ and
similar).
-__ https://docs.python.org/3/whatsnew/3.10.html
+__ https://docs.python.org/3/whatsnew/3.11.html
.. _supported versions:
diff --git a/docutils/docs/index.txt b/docutils/docs/index.txt
index 1d83f6f4f..964bd4b15 100644
--- a/docutils/docs/index.txt
+++ b/docutils/docs/index.txt
@@ -11,12 +11,12 @@
The latest working documents may be accessed individually below, or
from the ``docs`` directory of the `Docutils distribution`_.
-.. _Docutils: https://docutils.sourceforge.io/
.. _Docutils distribution: https://docutils.sourceforge.io/#download
.. header::
Docutils_ | Overview | About__ | Users__ | Reference__ | Developers__
+.. _Docutils: https://docutils.sourceforge.io/
__ `project fundamentals`_
__ user_
__ ref_
@@ -26,42 +26,14 @@ __ howto_
.. contents::
-Docutils Stakeholders
-=====================
-
-Docutils stakeholders can be categorized in several groups:
-
-1. End-users: users of reStructuredText and the Docutils tools.
- Although some are developers (e.g. Python developers utilizing
- reStructuredText for docstrings in their source), many are not.
-
-2. Client-developers: developers using Docutils as a library,
- programmers developing *with* Docutils.
-
-3. Component-developers: those who implement application-specific
- components, directives, and/or roles, separately from Docutils.
-
-4. Core-developers: developers of the Docutils codebase and
- participants in the Docutils project community.
-
-5. Re-implementers: developers of alternate implementations of
- Docutils.
-
-There's a lot of overlap between these groups. Most (perhaps all)
-core-developers, component-developers, client-developers, and
-re-implementers are also end-users. Core-developers are also
-client-developers, and may also be component-developers in other
-projects. Component-developers are also client-developers.
-
-
Project Fundamentals
====================
-These files are for all Docutils stakeholders. They are kept at the
+These files are for all `Docutils stakeholders`_. They are kept at the
top level of the Docutils project directory.
.. class:: narrow run-in
-
+
:README_: Project overview: quick-start, requirements,
installation, and usage.
:COPYING_: Conditions for Docutils redistribution, with links to
@@ -85,6 +57,39 @@ top level of the Docutils project directory.
.. _THANKS: ../THANKS.html
+.. _docutils stakeholders:
+.. class:: details
+
+Docutils Stakeholders …
+ can be categorized in several groups:
+
+ End-users:
+ users of reStructuredText and the Docutils tools.
+ Although some are developers (e.g. Python developers utilizing
+ reStructuredText for docstrings in their source), many are not.
+
+ Client-developers:
+ developers using Docutils as a library,
+ programmers developing *with* Docutils.
+
+ Component-developers:
+ those who implement application-specific components,
+ directives, and/or roles, separately from Docutils.
+
+ Core-developers:
+ developers of the Docutils codebase and participants
+ in the Docutils project community.
+
+ Re-implementers:
+ developers of alternate implementations of Docutils.
+
+ There's a lot of overlap between these groups. Most (perhaps all)
+ core-developers, component-developers, client-developers, and
+ re-implementers are also end-users. Core-developers are also
+ client-developers, and may also be component-developers in other
+ projects. Component-developers are also client-developers.
+
+
.. _user:
Introductory & Tutorial Material for End-Users
@@ -109,7 +114,7 @@ Writer-specific:
* `Quick reStructuredText <user/rst/quickref.html>`__ (user reference)
* `reStructuredText Cheat Sheet <user/rst/cheatsheet.txt>`__ (text
only; 1 page for syntax, 1 page directive & role reference)
- * `Demonstration <user/rst/demo.html>`_
+ * `Demonstration <user/rst/demo.html>`_
of most reStructuredText features
(see also the `text source <user/rst/demo.txt>`__)
@@ -157,7 +162,7 @@ Python Enhancement Proposals
implementation details. [:PEP:`258` in the `master repository`_]
* `PEP 287: reStructuredText Docstring Format`__ proposes a standard
markup syntax. [:PEP:`287` in the `master repository`_]
-
+
Please note that PEPs in the `master repository`_ developed
independent from the local versions after submission.
@@ -171,7 +176,7 @@ Python Enhancement Proposals
Prehistoric:
`Setext Documents Mirror`__
-
+
__ https://docutils.sourceforge.io/mirror/setext.html
@@ -182,8 +187,8 @@ API Reference Material for Client-Developers
* `The Docutils Publisher <api/publisher.html>`__
* `Docutils Runtime Settings <api/runtime-settings.html>`__
-* `Docutils Transforms <api/transforms.html>`__
-
+* `Docutils Transforms <api/transforms.html>`__
+
The `Docutils Design Specification`_ (PEP 258) is a must-read for any
Docutils developer.
diff --git a/docutils/docs/user/config.txt b/docutils/docs/user/config.txt
index 9b867c838..f30a00c32 100644
--- a/docutils/docs/user/config.txt
+++ b/docutils/docs/user/config.txt
@@ -1639,7 +1639,7 @@ Options for the `hyperref TeX package`_. If hyperlink_color_ is
not "false", the expansion of ::
'colorlinks=true,linkcolor=%s,urlcolor=%s' % (
- hyperlink_color, self.hyperlink_color
+ hyperlink_color, hyperlink_color)
is prepended.
diff --git a/web/index.txt b/web/index.txt
index f915a1b97..2ae30642d 100644
--- a/web/index.txt
+++ b/web/index.txt
@@ -59,7 +59,7 @@ than the "official" releases |---| they're not only for developers!
.. [#] Snapshots are created on-demand by Sourceforge. You can
download a snapshot of the complete `trunk directory`_ (docutils,
- sandbox_, prest/perl and web) or any sub-directory. Browse to the
+ sandbox_, and web) or any sub-directory. Browse to the
desired directory and click the "Download Snapshot" button.
----------------------------------------------------------------------