Skip to content

Commit dc4dfe8

Browse files
[doc] Simplify the doc on how to build documentation
build-html does not exists anymore.
1 parent da7d696 commit dc4dfe8

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

doc/development_guide/contributor_guide/contribute.rst

+4-6
Original file line numberDiff line numberDiff line change
@@ -125,14 +125,12 @@ Tips for Getting Started with Pylint Development
125125
Building the documentation
126126
----------------------------
127127

128-
You can use the makefile in the doc directory with ``make html`` to build the
129-
documentation. To test smaller changes you can consider ``build-html``, which skips some checks but will be faster::
128+
You can use the makefile in the doc directory to build the documentation::
130129

131-
$ cd doc
132-
$ make install-dependencies
133-
$ make html
130+
$ make -C doc/ install-dependencies
131+
$ make -C doc/ html
134132

135-
We're reusing generated files for speed, use ``make clean`` when you want to start from scratch.
133+
We're reusing generated files for speed, use ``make clean`` or ``tox -e docs`` when you want to start from scratch.
136134

137135
How to choose the target version ?
138136
----------------------------------

0 commit comments

Comments
 (0)