diff options
| author | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2022-05-16 11:49:55 +0200 |
|---|---|---|
| committer | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2022-05-16 12:21:17 +0200 |
| commit | 609b667dd9ce8310a82fd01519f053a1e7d74d50 (patch) | |
| tree | 4c9875e0d310a9506f133b9929e90e6e9e7ba7af /doc/development_guide | |
| parent | 64989b2601ff19926e43611c987e651e9211fe42 (diff) | |
| download | pylint-git-609b667dd9ce8310a82fd01519f053a1e7d74d50.tar.gz | |
[doc] Add a job to install the dependencies before build-html
Diffstat (limited to 'doc/development_guide')
| -rw-r--r-- | doc/development_guide/contribute.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/development_guide/contribute.rst b/doc/development_guide/contribute.rst index 07dc2c37d..328f86b1b 100644 --- a/doc/development_guide/contribute.rst +++ b/doc/development_guide/contribute.rst @@ -87,10 +87,11 @@ Tips for Getting Started with Pylint Development Building the documentation ---------------------------- -You can use the makefile and build-html command for building the documentation during developement:: +You can use the makefile in the doc directory with ``make html`` to build the +documentation. To test smaller changes you can consider ``build-html``, which skips some checks but will be faster:: $ cd doc - $ pip install -r requirements.txt + $ make install-dependencies $ make build-html We're reusing generated files for speed, use ``make clean`` when you want to start from scratch. |