summaryrefslogtreecommitdiff
path: root/docs/Makefile
AgeCommit message (Collapse)Author
2022-09-29docs/Makefile: Enable parallel compilation for Sphinx.Jim Mussared
This has a fairly dramatic (nearly 3x on a 6-core machine) speedup for docs compilation, with no impact on correctness. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
2020-06-05docs: Fix Sphinx 3.x warnings, and enable warnings-as-errors on build.David Lechner
This enables warnings as errors and fixes all current errors, namely: - reference to terms in the glossary must now be explicit (:term:) - method overloads must not be declared as a separate method or must use :noindex: - 2 cases where `` should have been used instead of `
2017-02-27docs/Makefile: define and use PYTHON as the interpreter for CPYDIFFKrzysztof Blazewicz
User can override PYTHON executable before running script, gen-cpydiff.py works only with Python3 and most systems register its executable as 'python3'.
2017-02-20docs: Modify Makefile and indexes to generate cPy-differences pages.Rami Ali
2016-06-14docs: Rebuild docs from scratch, as required for proper only:: handling.Paul Sokolovsky
Docs are now by default rebuilt from scratch, as required to build conditionalized (i.e. using only:: directive) docs across different output types. We have pretty small docset, so that's still rather fast. However, if that's a concern, incremental rebuilds can be used by passing "FORCE=" (nothing after =) as a make parameter. This will work when using the same output type (e.g. only "html").
2016-04-27docs/Makefile: Default BUILDDIR based on MICROPY_PORT.Paul Sokolovsky
It doesn't make sense to duplicate both on command line, and MICROPY_PORT is effectively mandatory to build docs.
2014-09-25docs: Initial commit of Sphinx documentation framework.Damien George