Docutils | Overview | About | Users | Reference | Developers

The Docutils Version Repository

Author:

Lea Wiemann, Docutils developers

Contact:
docutils-develop@lists.sourceforge.net
Revision:
10020
Date:
2025-03-07

Docutils uses a Subversion (SVN) repository located at docutils.svn.sourceforge.net.

While Unix and Mac OS X users will probably prefer the standard Subversion command line interface, Windows user may want to try TortoiseSVN, a convenient explorer extension. The instructions apply analogously.

There is a Git mirror at http://repo.or.cz/docutils.git providing web access and the base for creating a local Git clone. [1]

For the project policy on repository use (check-in requirements, branching, etc.), please see the Docutils Project Policies.

Accessing the Repository

Web Access

The repository can be browsed and examined via the web at https://sourceforge.net/p/docutils/code.

Alternatively, use the web interface at http://repo.or.cz/docutils.git. [1]

Repository Access Methods

To get a checkout, first determine the root of the repository depending on your preferred protocol:

anonymous access: (read only)

Subversion: https://svn.code.sf.net/p/docutils/code

Git: git://repo.or.cz/docutils.git

developer access: (read and write)

svn+ssh://<USERNAME>@svn.code.sf.net/p/docutils/code

Checking Out the Repository

Git users can clone a mirror of the docutils repository with

git clone git://repo.or.cz/docutils.git

and proceed according to the Git documentation. Developer access (read and write) is possible with git svn.

Subversion users can use the following commands (substitute your preferred repository root for ROOT):

  • To check out only the current main source tree of Docutils, type

    svn checkout ROOT/trunk/docutils
  • To check out everything (main tree, sandboxes, web site, and parallel projects), type

    svn checkout ROOT/trunk docutils

    This will create a working copy of the whole trunk in a new directory called docutils.

Note that you probably do not want to check out the ROOT itself (without "/trunk"), because then you'd end up fetching the whole Docutils tree for every branch and tag over and over again.

To update your working copy later on, cd into the working copy and type

svn update

Switching the Repository Root

If you changed your mind and want to use a different repository root, cd into your working copy and type:

svn switch --relocate OLDROOT NEWROOT

Editable installs

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.

  1. Do an editable install with