summaryrefslogtreecommitdiff
path: root/docs/conf.py
AgeCommit message (Collapse)Author
2017-08-23docs: Bump version to 1.9.2.v1.9.2Damien George
2017-07-02docs/conf.py: Set "version" and "release" to the same value.Paul Sokolovsky
We don't use alpha/beta/RC, so for us version and release should be the same, or it leads to confusion (for example, current, 1.9.1 docs are marked as 1.9 at places).
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/conf.py: Switch to "new" format of intersphinx_mapping.Paul Sokolovsky
As described at http://www.sphinx-doc.org/en/stable/ext/intersphinx.html#confval-intersphinx_mapping This will allow to explicitly refer to CPython docs for cross-references.
2017-07-01docs/conf.py: Add .venv dir to exclude_patterns.Paul Sokolovsky
It's useful to try different Sphinx versions using virtualenv/venv, so exclude a common venv dir name from Sphinx processing.
2017-06-25docs/conf.py: Set default_role = 'any'.Paul Sokolovsky
This causes `symbol` syntax to be equivalent to :any:`symbol`, which is in turn the easiest way to cross-reference an arbitrary symbol in the docs: http://www.sphinx-doc.org/en/stable/markup/inline.html#role-any :any: requires at least Sphinx 1.3 (for reference, Ubuntu 16.03 ships with 1.3.6, the latest 1.6.3). Any many of our docs, `symbol` is misused to specify arguments to functions, etc. Refactoring that is in progress. (CODECONVENTIONS already specify proper syntax for both arguments and xrefs, based on CPython conventions).
2017-06-24docs/conf.py: Include 3 levels of ToC in latexpdf output.Paul Sokolovsky
Instead of default 2. 3 are required to access description of individual library modules.
2017-06-11docs: Bump version to 1.9.1.v1.9.1Damien George
2017-05-26docs: Bump version to 1.9.v1.9Damien George
2017-02-07docs: Add M-logo as favicon.Damien George
2017-01-29docs/conf.py: Add myself as a copyright holder on the docs.Paul Sokolovsky
Based on the following statistics: $ git log docs |grep Author | sort | uniq -c | sort -n -r 175 Author: Paul Sokolovsky 135 Author: Damien George 31 Author: Daniel Campora 26 Author: danicampora 14 Author: Peter Hinch git blame stats script from http://stackoverflow.com/a/13687302/496009: $ sh git-authors docs 9977 author Damien George 2679 author Paul Sokolovsky 1699 author Daniel Campora 1580 author danicampora 1286 author Peter Hinch 282 author Shuning Bian 249 author Dave Hylands Total lines per this script: 18417, my contribution is 14.5%.
2017-01-08docs: Bump version to 1.8.7.v1.8.7Damien George
2016-11-10docs: Bump version to 1.8.6.v1.8.6Damien George
2016-10-17docs: Bump version to 1.8.5.v1.8.5Damien George
2016-09-09docs: Bump version to 1.8.4.v1.8.4Damien George
2016-08-09docs: Bump version to 1.8.3.v1.8.3Damien George
2016-07-10docs: Bump version to 1.8.2.v1.8.2Damien George
2016-06-19docs/conf.py: Exclude cmath from modindex for wipy.Paul Sokolovsky
2016-06-12docs/conf.py: Active sphinx_selective_exclude extensions.Paul Sokolovsky
For modindex_exclude extension, per-port module excludes are also added. With these changes, it's possible to generate docs for a particular port devoid of any superfluous and unrelated content, including in indexes and full-text search - with small caveat: when generating PDF docs after HTML, or vice-versa cached internal doctree representation (build/*/doctrees/) must be removed first.
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-06-03docs: Bump version to 1.8.1.v1.8.1Damien George
2016-05-03docs: Bump version to 1.8.v1.8Damien George
2016-04-28docs: Make the short port names in the port/version sidebar lowercase.Damien George
To make it neater and simpler.
2016-04-11docs: Bump version to 1.7.v1.7Damien George
2016-04-07docs: esp8266: Enable "machine" module docs.Paul Sokolovsky
The docs are still heavily biased towards WiPy, so will need a lot of exclusions.
2016-04-03docs: Update copyright notice.Paul Sokolovsky
2016-03-09docs: Allow list of versions to be specified by environment variable.Damien George
2016-03-09docs: Add versions.html template and support code for a version sidebar.Damien George
2016-01-31docs: Bump version to 1.6.v1.6Damien George
2016-01-03docs: Set author as 'Damien P. George and contributors'.Paul Sokolovsky
2016-01-03docs: Fix readthedocs build by updating Latex params.Paul Sokolovsky
2015-12-31docs: Bump version to 1.5.2.v1.5.2Damien George
2015-11-23docs: Bump version to 1.5.1.v1.5.1Damien George
2015-10-21docs: Bump version to 1.5.v1.5Damien George
2015-10-17docs: Update all WiPy docs to reflect the new API.danicampora
2015-09-23docs: Bump version to 1.4.6.v1.4.6Damien George
2015-08-11docs: Bump version to 1.4.5.v1.4.5Damien George
2015-06-15docs: Bump version to 1.4.4.v1.4.4Damien George
2015-06-10docs: Add initial draft documentation for the WiPy.Daniel Campora
This makes all common files "port-aware" using the .. only directive.
2015-06-04docs: Change "Micro Python" to "MicroPython" in all places in docs.Damien George
2015-06-04docs: Generate a separate docs build for each port.Daniel Campora
Using Damien's approach where conf.py and topindex.html are shared by all ports.
2015-05-16docs: Bump version to 1.4.3.v1.4.3Damien George
2015-04-21docs: Bump version to 1.4.2.v1.4.2Damien George
2015-04-04docs: Bump version to 1.4.1.v1.4.1Damien George
2015-03-29docs: Bump version to 1.4.v1.4Damien George
2015-02-13docs: Bump version to 1.3.10.v1.3.10Damien George
2015-01-25docs: Bump version to 1.3.9.v1.3.9Damien George
2014-12-29docs: Bump version to 1.3.8.Damien George
Should have done it before tagging...
2014-12-21docs: Add custom CSS file, with code for admonition.Damien George
2014-11-28docs: Bump version to 1.3.7.v1.3.7Damien George