Commit graph

22 commits

Author SHA1 Message Date
Simon Willison
47e4060469 Enable MyST Markdown docs, port events.rst, refs #2565 2025-10-31 16:38:04 -07:00
Simon Willison
bcc4f6bf1f
track_event() mechanism for analytics and plugins
* Closes #2240
* Documentation for event plugin hooks, refs #2240
* Include example track_event plugin in docs, refs #2240
* Tests for track_event() and register_events() hooks, refs #2240
* Initial documentation for core events, refs #2240
* Internals documentation for datasette.track_event()
2024-01-31 15:21:40 -08:00
Simon Willison
50a6355c08 Workaround to get sphinx-build working again, refs 1153 2023-07-08 11:22:21 -07:00
Simon Willison
d7b21a8623 metadata.yaml now treated as default in docs
Added sphinx-inline-tabs to provide JSON and YAML tabs to show examples.

Refs #1153
2023-07-08 09:37:01 -07:00
Simon Willison
3af313e165 Fix for Sphinx extlinks warning, closes #1972 2022-12-31 11:13:14 -08:00
Chris Holdgraf
994ce46ed4
Add favicon to documentation (#1967)
Co-authored-by: Simon Willison <swillison@gmail.com>
2022-12-31 11:00:31 -08:00
Simon Willison
d0476897e1 Fixed Sphinx warning about language = None 2022-09-06 11:24:30 -07:00
Simon Willison
8dd816bc76 Applied Black 2022-05-30 15:42:38 -07:00
Simon Willison
b010af7bb8
Updated copyright years in documentation footer 2022-05-20 15:23:09 -07:00
Simon Willison
1d33fd03b3 Switch docs theme to Furo, refs #1746 2022-05-20 13:34:51 -07:00
Simon Willison
1465fea479 sphinx-copybutton for docs, closes #1748 2022-05-20 12:11:28 -07:00
Simon Willison
d9b508ffaa @documented decorator plus unit test plus sphinx.ext.autodoc
New mechanism for marking datasette.utils functions that should be covered by the
documentation, then testing that they have indeed been documented.

Also enabled sphinx.ext.autodoc which can now be used to embed the documented
versions of those functions.

Refs #1176
2022-02-06 22:31:06 -08:00
Simon Willison
59ef4a20cb
© 2017-2021 2021-04-02 13:27:03 -07:00
Simon Willison
d2d53a5559 New :issue: Sphinx macro, closes #1227 2021-02-17 17:20:15 -08:00
Simon Willison
ee0ef01652 Added new logo to the documentation 2020-07-12 12:53:29 -07:00
Simon Willison
d828abadde Fix horizontal scrollbar on changelog, refs #828 2020-06-09 21:20:07 -07:00
Simon Willison
25014ca25e
Configuration directory mode, closes #731 2020-04-27 09:30:24 -07:00
Simon Willison
b38a792ef0 Apply Black, update copyright to be 2017-2020 2020-02-13 15:01:14 -08:00
Simon Willison
7c79eb974b
It's 2019 now 2019-05-16 03:20:08 -07:00
Simon Willison
1c815207cc
Update conf.py 2018-05-12 09:08:11 -03:00
Simon Willison
cf46b86cf7
Switch to sphinx_rtd_theme 2017-11-30 08:56:20 -08:00
Simon Willison
e6ca885883 Added initial docs, including a changelog
Docs initialized using this helpful guide:

http://docs.readthedocs.io/en/latest/getting_started.html

I used https://pypi.python.org/pypi/gitchangelog to kick-start the changelog.

Closes #99

Refs #109
2017-11-16 07:11:00 -08:00