EronHennessey / rst-examples

A Sphinx project that provides examples of reStructuredText syntax. Add your own examples!

This project provides examples of reStructuredText syntax for quick understanding and easy reference.

Examples are provided in files that describe their contents. For example, tables.rst contains examples of writing tables in reST.

Building the examples

You'll need Sphinx to build the project. If you have pip installed, you can install Sphinx with:

pip install Sphinx

To build the project, run the following command within the top directory of this repository:

sphinx-build -b html . _output

Then open _output/index.html in your web browser to view the content.

License

This repository uses the Creative Commons Zero license. The text within these files is dedicated to the Public Domain, and you are free to use it in any way you see fit. View the LICENSE for more information.