mirror of
https://github.com/certbot/certbot.git
synced 2026-07-27 16:30:31 +02:00
Add documentation instructions/fix documentation of an ivar
This commit is contained in:
@@ -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.
|
||||
|
||||
@@ -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`)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user