Add documentation instructions/fix documentation of an ivar

This commit is contained in:
James Kasten
2015-01-16 04:10:23 -08:00
parent 3cf59a2876
commit d15e0f9e43
2 changed files with 14 additions and 1 deletions
+13
View File
@@ -70,6 +70,19 @@ style](#coding-style)**. The following tools are there to help you:
- `./venv/bin/tox -e lint` checks the style of the whole project,
while `./venv/bin/pylint --rcfile=.pylintrc file` will check a single `file` only.
## Documentation
In order to generate the sphinx documentation, run the following commands.
```
./venv/bin/python setup.py docs
cd docs
make SPHINXBUILD='../venv/bin/python /usr/local/bin/sphinx-build'
```
This should generate documentation in the /lets-encrypt-preview/docs/_build/html
directory.
### Coding style
Most importantly, **be consistent with the rest of the code**, please.
+1 -1
View File
@@ -67,7 +67,7 @@ class ApacheConfigurator(augeas_configurator.AugeasConfigurator):
:ivar str server_root: Path to Apache root directory
:ivar dict location: Path to various files associated
with the configuration
:ivar float version: version of Apache
:ivar tup version: version of Apache
:ivar list vhosts: All vhosts found in the configuration
(:class:`list` of :class:`letsencrypt.client.apache.obj.VirtualHost`)