summaryrefslogtreecommitdiff
path: root/docs/Makefile
AgeCommit message (Collapse)Author
2018-05-14Cleaning up and fixing the docs generation Makefile and README instructionsKarin Hawley
- moving Makefile to parent folder. This resolves some of the weird path/build issues - remove trace references to cpydiff and original file (no longer used anywhere) - converting SOURCEDIR to a changeable variable, passed through all sphinx-build calls - adding path to conf.py, in case it moves again - making `-v` default with VERBOSE - making `-E` default with FORCE - creating BASEOPTS to store all the dirs, paths, and settings, passing them to sphinx-build in one long chain, instead of individually - updating README to use the make command as default. Also added text explaining some of the customization you can add into a make command
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