Skip to main content

reST utils

Project description


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

$ 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/
Using /Users/gawel/py/rstctl/rstctl/module.tmpl
Writing docs/modules/rstctl.txt
Skipping rstctl.pdf excluded by
Skipping rstctl.rst_directive excluded by
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

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

You can also add rstctl.sphinx in’s extensions

0.4 (2010-03-06)

  • add --sphinx option + sphinx extension

0.1 (2008-11-31)

  • initial release

Project details

Download files

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

Source Distribution

rstctl-0.4.tar.gz (7.5 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page