summaryrefslogtreecommitdiff
path: root/docs/templates
AgeCommit message (Collapse)Author
2021-08-13docs/templates: Add unix and zephyr quickref links to top-index.Damien George
Signed-off-by: Damien George <damien@micropython.org>
2021-05-30docs/rp2: Add skeleton docs for the rp2 port.Matt Trentini
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 `
2019-11-07docs/templates/topindex.html: Replace usage of deprecated defindex.html.Jim Mussared
defindex.html (used by topindex.html) is deprecated, but topindex.html was already identical other than setting the title, so just inherit directly from layout.html.
2019-01-25docs: Add initial docs for esp32 port, including quick-ref and general.Matt Trentini
With contributions from Oliver Robson (@HowManyOliversAreThere), Sean Lanigan (@seanlano) and @rprr.
2018-10-01docs: Unify all the ports into one set of documentation.Damien George
With this commit there is now only one entry point into the whole documentation, which describes the general MicroPython language, and then from there there are links to information about specific platforms/ports. This commit doesn't change content (almost, it does fix a few internal links), it just reorganises things.
2017-07-03docs/pyboard: Move info about using Windows from topindex to general.Damien George
2017-07-02docs/pyboard: Move hardware info into General Info chapter.Paul Sokolovsky
This makes top-level ToC of the pyboard docs consistent with other ports (consisting of 3 chapters: QuickRef, General Info, and Tutorial). Also, some other minor tweaks applied, like local ToC for General Info and headings mentioning pyboard.
2017-07-02docs/replace.inc: Add |see_cpython|, to xref individual symbols from CPython.Paul Sokolovsky
The idea is to use it for each symbol in builtins.rst.
2017-07-02docs/library: Add CPython docs xref to each pertinent module.Paul Sokolovsky
Cross-reference text/link is implemented as RST substitution, so easy to consistently.
2017-07-02docs/conf.py: Add file for global replacements definition.Paul Sokolovsky
The idea is to allow to define a kind of "macros" for repeatitive text, so all occurrances can be updated in one place. Unfortunately, RST doesn't support replacements with arguments, which limits usefulness of them and should be taken into account.
2017-07-02docs/topindex.html: Fix typo in "Glossary" heading.Damien George
2017-07-02docs: Add glossary.Paul Sokolovsky
We have enough terms or references throughout the docs which may be not immediately clear or have some important nuances. Referencing terms in gloassary is the best way to deal with that.
2017-07-01docs: Move topindex.html to templates/ subdir.Damien George
Later versions of jinja2 need it to be in this subdir, and earlier versions work with it here as well.
2016-06-06docs: Add link to PDF version of docs in sidebar.Damien George
Requires a link of the form: <BASEURL>/<lang>/<ver>/micropython-<port>.pdf
2016-04-28docs: Make the short port names in the port/version sidebar lowercase.Damien George
To make it neater and simpler.
2016-03-09docs: Add versions.html template and support code for a version sidebar.Damien George
2015-06-27docs: Make index link point to "index.html" irrespective of port.Damien George
2014-12-21docs: Add custom CSS file, with code for admonition.Damien George