summaryrefslogtreecommitdiff
path: root/docs/README.md
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-08-16Update docs README to mention requirement for recommonmark dependency.Tony DiCola
2017-06-27Split uos module into os and storage.Scott Shawcroft
os is a subset of CPython's os. storage contains additional file system mounting functionality based on UNIX's mount management. Fixes #140
2016-10-18Documentation rework to unify the docs together rather than having themScott Shawcroft
on a per port basis. Also enables generating docs from inline RST in C code. Simply omits all lines except those that start with //|. Indentation after "//| " will be preserved.
2016-08-02docs: Spelling mistakesMike Causer
2016-06-02docs/README: Add some hints for PDF docs generation.Paul Sokolovsky
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.
2015-11-03docs: Move instructions on generating the documentation to docs/README.mdDave Hylands