Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

reST utils

Project description

Description

rstctl is a script to help you with reStructuredText

Usage

HTML preview

You can preview a file:

$ rstctl -w path/to/file.rst

Or the long description of a package:

$ ls setup.py
setup.py

$ rstctl -w

This will open the result in your favorite browser.

Generating Sphinx documentation

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

$ rstctl --sphinx docs/conf.py
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:

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

Project details


Release history Release notifications

This version
History Node

0.4

History Node

0.3

History Node

0.2

History Node

0.1

History Node

0.1dev-r1221

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
rstctl-0.4.tar.gz (7.5 kB) Copy SHA256 hash SHA256 Source None Mar 6, 2010

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page