Pierre Sassoulas
d11bfec689
[doc] Activate the nitpicky option in sphinx build ( #6650 )
...
This will warn about all missing references
* Remove references that don't work
Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
2022-05-22 19:22:26 +02:00
Daniël van Noord
57c0cd08b5
Run `linkcheck` and message generation in quiet mode ( #6649 )
...
Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
2022-05-19 09:54:06 +02:00
Pierre Sassoulas
cf33fcffa1
[doc] Move all messages documentation to user_guide/messages
2022-05-18 14:54:06 +02:00
Pierre Sassoulas
95be3b90fc
[doc] Clean all generated files in the doc's 'make clean'
2022-05-16 12:21:17 +02:00
Pierre Sassoulas
609b667dd9
[doc] Add a job to install the dependencies before build-html
2022-05-16 12:21:17 +02:00
Pierre Sassoulas
252a0e0ab8
[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
2022-05-16 12:21:17 +02:00
Pierre Sassoulas
71f93af8cc
Makefile that expect the requirements to be installed
2022-05-16 12:21:17 +02:00
Daniël van Noord
897ea1d8fa
Update Sphinx makefiles with options used on readthedocs
2022-04-13 12:35:14 +02:00
Daniël van Noord
bbb54188c4
Use `namespace in --generate-rcfile` ( #6282 )
...
Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
2022-04-13 10:08:07 +02:00
Daniël van Noord
4c2eb2d293
Create separate documentation page for each message ( #5396 )
...
Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
2022-01-28 23:00:40 +01:00
Claudiu Popa
ca6a644ffb
Remove pylint/utils.py from the documentation build since it is not needed
2019-11-21 09:16:03 +01:00
Benjamin Drung
3c2fb0ef2f
[doc] Support specifying the Python interpreter
...
On Debian, the binary `python` will always point to Python 2. When
building the documentation, there is no way to change the Python
interpreter to Python 3 on Debian.
Therefore allow specifying PYTHON to override the Python interpreter.
2018-09-28 14:34:49 +02:00
Ville Skyttä
7f07744de8
Generate example pylintrc and man page with /dev/null pylintrc
...
To avoid e.g. user pylintrc affecting the output.
2018-06-13 09:12:41 +02:00
Claudiu Popa
2a18953368
Install python-docs-theme before building the odocumentation
2018-06-05 08:18:24 -07:00
Claudiu Popa
31096db040
Move parts of the documentation into their own folder section.
2016-08-14 21:01:58 +03:00
Glenn Matthews
07cd560c13
Automatic generation of extensions.rst ( #988 )
2016-07-10 11:18:24 +01:00
Sandro Tosi
5989e64719
Make the doc buildable using the current checkout
...
Passing the PYTHONPATH from the command line, and setting PATH to the built
script, this change will make it possible to use the built code used instead of
the system-wide installation to build the documentation.
Usage example:
PATH=./build/scripts-2.7:$PATH make -C doc html PYTHONPATH=./build/lib
2015-03-01 12:49:09 +00:00
Claudiu Popa
c03fefdefb
Add new '-j' option for running checks in sub-processes.
...
Patch by Michal Nowikowski.
2014-10-15 14:30:13 +03:00
Sylvain Thénault
a321a9ce48
[doc] fix makefile to ensure features.rst is systemactically regenerated
2013-09-25 08:54:02 +02:00
Nicolas Chauvat
525ce361fe
[doc] continue refactoring
2013-04-29 15:31:03 +02:00
Sylvain Thénault
8d3422e502
[doc gen] fix feature.rst generation rule in Makefile and remove it from hg
2013-04-25 09:35:13 +02:00
Sylvain Thénault
88dc9daedb
[doc] redo some of my changes after rebasing nico's changes; rm former manual/quickstart
2013-04-17 10:33:52 +02:00
Nicolas Chauvat
575b69cfb3
[doc] complete refactoring
2013-04-06 21:45:15 +02:00
Nicolas Chauvat
fa3ce6ac00
[doc] generate documentation with sphinx
2013-04-04 21:22:33 +02:00
