diff options
| author | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2022-05-16 10:39:40 +0200 |
|---|---|---|
| committer | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2022-05-16 12:21:17 +0200 |
| commit | 252a0e0ab82d344def8f7bfb447a00ff9e423db5 (patch) | |
| tree | 9ff78af2a93a64d0afa22844930ad1c3cbce562d | |
| parent | 2075cf302c7945d96f8bb92d192234a111127f33 (diff) | |
| download | pylint-git-252a0e0ab82d344def8f7bfb447a00ff9e423db5.tar.gz | |
[doc] Use a saved environment, do not always read all files
In the CI we have a fresh environnement, so this option is just making repeated build slower locally
| -rw-r--r-- | doc/Makefile | 6 | ||||
| -rw-r--r-- | doc/development_guide/contribute.rst | 8 |
2 files changed, 10 insertions, 4 deletions
diff --git a/doc/Makefile b/doc/Makefile index e7bca8aa9..c87747563 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -13,7 +13,7 @@ PYTHONPATH = # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees -T -E -W --keep-going $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees -T -W --keep-going $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck @@ -36,7 +36,9 @@ help: @echo " linkcheck to check all external links for integrity" clean: - -rm -rf $(BUILDDIR)/* + -rm -rf $(BUILDDIR)/* messages/convention messages/error messages/fatal messages/information \ + messages/refactor messages/warning + build-html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html diff --git a/doc/development_guide/contribute.rst b/doc/development_guide/contribute.rst index 116dbebce..07dc2c37d 100644 --- a/doc/development_guide/contribute.rst +++ b/doc/development_guide/contribute.rst @@ -87,6 +87,10 @@ Tips for Getting Started with Pylint Development Building the documentation ---------------------------- -We use **tox** for building the documentation:: +You can use the makefile and build-html command for building the documentation during developement:: - $ tox -e docs + $ cd doc + $ pip install -r requirements.txt + $ make build-html + +We're reusing generated files for speed, use ``make clean`` when you want to start from scratch. |