Welcome, guest | Sign In | My Account | Store | Cart

Notice! PyPM is being replaced with the ActiveState Platform, which enhances PyPM’s build and deploy capabilities. Create your free Platform account to download ActivePython or customize Python with the packages you require and get automatic updates.

pypm install rstctl

How to install rstctl

  1. Download and install ActivePython
  2. Open Command Prompt
  3. Type pypm install rstctl
 Python 2.7Python 3.2Python 3.3
Windows (32-bit)
0.4 Available View build log
Windows (64-bit)
0.4 Available View build log
Mac OS X (10.5+)
0.4 Available View build log
Linux (32-bit)
0.4 Available View build log
Linux (64-bit)
0.4 Available View build log
Lastest release
version 0.4 on Jan 5th, 2011


rstctl is a script to help you with reStructuredText


HTML preview

You can preview a file:

$ rstctl -w path/to/file.rst

Or the long description of a package:

$ ls setup.py

System Message: ERROR/3 (<string>, line 21)

Inconsistent literal block quoting.


$ rstctl -w

This will open the result in your favorite browser.


`incomplete ref`_

$ ./bin/rstctl -l README.txt <string>:4: (ERROR/3) Unknown target name: "incomplete ref".

1 links append to README.txt $ cat README.txt Title =====

`incomplete ref`_

System Message: WARNING/2 (<string>, line 54); backlink

Duplicate explicit target name: "incomplete ref".

Then you can add the correct links.

Generating Sphinx documentation

Go to the package root then use the --sphinx option:

$ rstctl --sphinx docs/conf.py

System Message: ERROR/3 (<string>, line 64)

Inconsistent literal block quoting.

Using /Users/gawel/py/rstctl/rstctl/module.tmpl Writing docs/modules/rstctl.txt Skipping rstctl.pdf excluded by conf.py Skipping rstctl.rst_directive excluded by conf.py Using /Users/gawel/py/rstctl/rstctl/module.tmpl Writing docs/modules/rstctl.serve.txt Using /Users/gawel/py/rstctl/rstctl/module.tmpl Writing docs/modules/rstctl.template.txt Using /Users/gawel/py/rstctl/rstctl/module.tmpl Writing docs/modules/rstctl.utils.txt Writing index

Add modules/index in a toctree

If you want to exclude some modules add this to your conf.py:

System Message: WARNING/2 (<string>, line 80)

Literal block expected; none found.

rstctl_exclude = ['rstctl.rst_directive', 'rstctl.pdf']

You can also add rstctl.sphinx in conf.py's extensions

0.4 (2010-03-06)

  • add --sphinx option + sphinx extension

0.1 (2008-11-31)

  • initial release

Docutils System Messages

System Message: ERROR/3 (<string>, line 37); backlink

Duplicate target name, cannot be used as a unique reference: "incomplete ref".

System Message: ERROR/3 (<string>, line 51); backlink

Duplicate target name, cannot be used as a unique reference: "incomplete ref".

Subscribe to package updates

Last updated Jan 5th, 2011

Download Stats

Last month:1

What does the lock icon mean?

Builds marked with a lock icon are only available via PyPM to users with a current ActivePython Business Edition subscription.

Need custom builds or support?

ActivePython Enterprise Edition guarantees priority access to technical support, indemnification, expert consulting and quality-assured language builds.

Plan on re-distributing ActivePython?

Get re-distribution rights and eliminate legal risks with ActivePython OEM Edition.