Project:Quality Assurance/Updating Policy Guide

From Gentoo Wiki
Jump to:navigation Jump to:search

Updating the website

Initial preparation

For convenience, clone the site repository inside the proj/policy-guide source tree:

user $mkdir _build
user $git clone _build/html

Install dev-python/tox.

Building the website

Run tox in order to install the necessary dependencies and run Sphinx to build the contents:

user $tox

The documentation will be written into _build/html. For multi-page version, open index.html. For single-page version, open combined.html.

Pushing the changes

Enter the _build/html checkout, commit your changes and push them:

user $cd _build/html
user $git add -A
user $git commit -sS
user $git push --signed