Commit Graph

47 Commits

Author SHA1 Message Date
Damien George 5653e3c72f docs: Bump version to 1.8.7. 2017-01-08 23:53:08 +11:00
Damien George 5a1d63fc14 docs: Bump version to 1.8.6. 2016-11-10 21:24:53 +11:00
Damien George c8d31585a0 docs: Bump version to 1.8.5. 2016-10-17 15:32:43 +11:00
Damien George 3611dcc260 docs: Bump version to 1.8.4. 2016-09-09 14:07:09 +10:00
Damien George e4e4526954 docs: Bump version to 1.8.3. 2016-08-09 23:49:25 +10:00
Damien George 1459a8d5c9 docs: Bump version to 1.8.2. 2016-07-10 12:46:50 +01:00
Paul Sokolovsky b2641b53e0 docs/conf.py: Exclude cmath from modindex for wipy. 2016-06-19 19:17:42 +03:00
Paul Sokolovsky 91031b60dc docs/conf.py: Active sphinx_selective_exclude extensions.
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-12 01:18:13 +03:00
Damien George 2bf6eb9fe2 docs: Add link to PDF version of docs in sidebar.
Requires a link of the form: <BASEURL>/<lang>/<ver>/micropython-<port>.pdf
2016-06-06 11:37:40 +01:00
Damien George 9b39263b11 docs: Bump version to 1.8.1. 2016-06-03 15:45:43 +01:00
Damien George 2c2fc070ec docs: Bump version to 1.8. 2016-05-03 17:32:32 +01:00
Damien George 37d5aa1377 docs: Make the short port names in the port/version sidebar lowercase.
To make it neater and simpler.
2016-04-28 12:34:59 +01:00
Damien George 9b0a150bd6 docs: Bump version to 1.7. 2016-04-11 12:18:10 +01:00
Paul Sokolovsky 9c04299da1 docs: esp8266: Enable "machine" module docs.
The docs are still heavily biased towards WiPy, so will need a lot of
exclusions.
2016-04-07 16:44:10 +03:00
Paul Sokolovsky 254a5646c1 docs: Update copyright notice. 2016-04-03 00:05:23 +03:00
Damien George 42ef5a1567 docs: Allow list of versions to be specified by environment variable. 2016-03-09 12:43:22 +00:00
Damien George 5b74bba3a3 docs: Add versions.html template and support code for a version sidebar. 2016-03-09 12:15:47 +00:00
Damien George 331a48195d docs: Bump version to 1.6. 2016-01-31 23:22:41 +00:00
Paul Sokolovsky 824f83fd20 docs: Set author as 'Damien P. George and contributors'. 2016-01-03 22:17:00 +02:00
Paul Sokolovsky 275a0f25d3 docs: Fix readthedocs build by updating Latex params. 2016-01-03 22:15:07 +02:00
Damien George ed584e2ffd docs: Bump version to 1.5.2. 2015-12-31 14:43:19 +00:00
Damien George 4dea24e105 docs: Bump version to 1.5.1. 2015-11-23 21:27:33 +00:00
Damien George fe08e3a54f docs: Bump version to 1.5. 2015-10-21 16:58:52 +01:00
danicampora 4542643025 docs: Update all WiPy docs to reflect the new API. 2015-10-17 23:29:04 +02:00
Damien George 5572f735b6 docs: Bump version to 1.4.6. 2015-09-23 17:16:22 +01:00
Damien George 032b0e9369 docs: Bump version to 1.4.5. 2015-08-11 13:42:30 +01:00
Damien George e78a8c94b6 docs: Bump version to 1.4.4. 2015-06-15 23:54:22 +01:00
Daniel Campora cfcf47c064 docs: Add initial draft documentation for the WiPy.
This makes all common files "port-aware" using the .. only directive.
2015-06-10 23:37:56 +02:00
Damien George 3eece29807 docs: Change "Micro Python" to "MicroPython" in all places in docs. 2015-06-04 23:53:26 +01:00
Daniel Campora 7ca1bd314b docs: Generate a separate docs build for each port.
Using Damien's approach where conf.py and topindex.html are
shared by all ports.
2015-06-04 23:44:35 +01:00
Damien George d7b7d5f6ee docs: Bump version to 1.4.3. 2015-05-16 21:26:43 +01:00
Damien George 43d56f9ba9 docs: Bump version to 1.4.2. 2015-04-21 12:51:14 +00:00
Damien George 0f6424efda docs: Bump version to 1.4.1. 2015-04-04 17:41:11 +01:00
Damien George 64e8b62291 docs: Bump version to 1.4. 2015-03-29 18:01:19 +01:00
Damien George 79dc0a0886 docs: Bump version to 1.3.10. 2015-02-13 13:26:44 +00:00
Damien George 552f7c40a0 docs: Bump version to 1.3.9. 2015-01-25 00:10:07 +00:00
Damien George 96e22154d7 docs: Bump version to 1.3.8.
Should have done it before tagging...
2014-12-29 00:04:59 +00:00
Damien George 9b561a7c0d docs: Add custom CSS file, with code for admonition. 2014-12-21 00:22:49 +00:00
Damien George 722fab7c2a docs: Bump version to 1.3.7. 2014-11-28 17:48:48 +00:00
Damien George 5228854f0e docs: Fix RTD build configuration.
ReadTheDocs needs the root directory in its search path so it finds
topindex.html.
2014-11-15 21:33:07 +00:00
evildmp aec189a5ba docs: Add optional sphinx_rtd_theme; add docs build instructions.
The sphinx_rtd_theme is used by ReadTheDocs to render a pretty looking
documentation.  If you have this theme installed locally then your
locally-compiled docs will look exactly like the published
documentation.   Otherwise it falls back to the default theme.
2014-11-15 19:01:19 +00:00
Damien George ff8d0e071c docs: Bump version to 1.3.6.
This needs to be done before actually tagging the new version.
2014-11-04 19:04:12 +00:00
Damien George 0e3722137f docs: Update front page to display date of last update. 2014-11-04 18:51:29 +00:00
Damien George f6e825b42e docs: Disable logo and add spacing to top index. 2014-11-02 23:45:29 +00:00
Damien George 6e6dfdc56b docs: Make custom index page; add more docs. 2014-11-02 23:37:02 +00:00
Damien George 88d3054ac0 docs: Import documentation from source-code inline comments.
The inline docs (prefixed with /// in .c files) have been converted to
RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
Damien George 6162bea5b2 docs: Initial commit of Sphinx documentation framework. 2014-09-25 17:23:06 +01:00