MalikAbuShabab/docs-style-guide

Documentation Style Guide for all projects under the Pylons Project

docs-style-guide

Pylons Project Documentation Style Guide

This project is the style guide for documentation of all projects under the Pylons Project.

Contributing

See contributing.md.

Installation

# Check out the project.
git clone https://github.com/Pylons/docs-style-guide.git
# Change your working directory to the project.
cd docs-style-guide
# Create a virtual environment.
python3 -m venv env
# Install the project in development mode.
env/bin/pip install -e .

Building documentation

We use tox to build the documentation and run tests. Install tox into your user space or virtual environment.

From the project root, run tox to build the documentation in HTML format.

tox -e html

When the build finishes, you'll find HTML documentation rendered in .tox/html.

To build all formats of the documentation, omit arguments.

tox