[Docutils-checkins] SF.net SVN: docutils:[8930] trunk/docutils

[<mi...@us...>]

Revision: 8930
          http://sourceforge.net/p/docutils/code/8930
Author:   milde
Date:     2022-01-04 22:53:36 +0000 (Tue, 04 Jan 2022)
Log Message:
-----------
Small revision of the documentation update.

Modified Paths:
--------------
    trunk/docutils/README.txt
    trunk/docutils/docs/dev/repository.txt

Modified: trunk/docutils/README.txt
===================================================================
--- trunk/docutils/README.txt	2022-01-04 17:03:32 UTC (rev 8929)
+++ trunk/docutils/README.txt	2022-01-04 22:53:36 UTC (rev 8930)
@@ -141,11 +141,6 @@
 
   To install a pre-relase, append the option ``--pre``.
 
-* For a *manual install* see the options in
-  `Setting up for Docutils development`__.
-
-  __ docs/dev/policies.html#setting-up-for-docutils-development
-
 * To install a `development version`_ from source with `setuptools`_:
 
   * Go to the directory containing the file ``setup.py``.
@@ -155,9 +150,14 @@
 
   * Run ``setup.py install``.
     On Windows systems it may be sufficient to double-click ``install.py``.
+    See also OS-specific installation instructions below.
 
-  OS-specific installation instructions follow below.
+* For installing "by hand" or in "development mode", see the
+  `editable installs`_ section in the `Docutils version repository`_
+  documentation.
 
+  .. _editable installs: docs/dev/repository.html#editable-installs
+
 Optional steps:
 
 * `Running the test suite`_

Modified: trunk/docutils/docs/dev/repository.txt
===================================================================
--- trunk/docutils/docs/dev/repository.txt	2022-01-04 17:03:32 UTC (rev 8929)
+++ trunk/docutils/docs/dev/repository.txt	2022-01-04 22:53:36 UTC (rev 8930)
@@ -133,11 +133,8 @@
 Editable installs
 =================
 
-The `Docutils project policies`_ require that any modifications must be
-tested_ before check-in_.
 There are several ways to ensure that edits to the Docutils code are
 picked up by Python.
-
 We'll assume that the Docutils "trunk" is checked out under the
 ``~/projects/`` directory.
 
@@ -154,8 +151,8 @@
 
 3. Install "manually".
 
-   To ensure the "docutils" package is in ``sys.path``, do one of the
-   following:
+   Ensure that the "docutils" package is in ``sys.path`` by
+   one of the following actions:
 
    * Set the ``PYTHONPATH`` environment variable so that Python
      picks up your local working copy of the code.
@@ -166,7 +163,7 @@
          export PYTHONPATH
 
      The first line points to the directory containing the ``docutils``
-     package.  The second line exports this environment variable.
+     package.  The second line exports the environment variable.
 
    * Create a symlink to the docutils package directory somewhere in the
      module search path (``sys.path``), e.g., ::
@@ -178,22 +175,20 @@
 
      __ https://docs.python.org/library/site.html
 
-   Optionally, add some or all `front-end tools`_ from ``docutils/tools``
+   Optionally, add some or all `front-end tools`_
    to the binary search path, e.g.,
+   add the ``tools`` directory to the ``PATH`` variable::
 
-   * add the ``tools`` directory to the ``PATH`` variable::
-
          PATH=$PATH:$HOME/projects/docutils/docutils/tools
          export PATH
 
-   * copy or link idividual front-end tools
-     to a suitable place in your binary path::
+   or link idividual front-end tools to a suitable place
+   in the binary path::
 
          ln -s ~/projects/docutils/docutils/tools/docutils-cli.py \
                /usr/local/bin/docutils
 
-5. Before you run anything, every time you make a change, reinstall
-   Docutils::
+5. Reinstall Docutils after any change::
 
        python3 setup.py install
 
@@ -222,9 +217,6 @@
     $ cd some-branch/docutils
     $ . set-PATHS
 
-.. _Docutils Project Policies: policies.html
-.. _check-in: policies.html#check-ins
-.. _tested: policies.html#tested
 .. _pip: https://pypi.org/project/pip/
 .. _setuptools: https://pypi.org/project/setuptools/
 .. _front-end tools: ../user/tools.html
@@ -246,6 +238,13 @@
 __ http://sourceforge.net/p/forge/documentation/svn/
 
 
+Ensure any changes comply with the `Docutils Project Policies`_
+before `checking in`_,
+
+.. _Docutils Project Policies: policies.html
+.. _checking in: policies.html#check-ins
+
+
 Setting Up Your Subversion Client For Development
 -------------------------------------------------
 

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.