remote/datasette
1
0
Fork 0
mirror of https://github.com/simonw/datasette.git synced 2026-06-02 07:07:00 +02:00
Code Issues Projects Releases Packages Wiki Activity
datasette/docs/index.rst

56 lines
2.1 KiB
ReStructuredText
Raw Normal View History

Removed accidental R
2019-05-16 06:27:08 -07:00
Datasette
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
=========
Add badges to documentation index
2020-05-03 08:46:49 -07:00
|PyPI| |Changelog| |Python 3.x| |Travis CI| |License| |docker:
datasette|
.. |PyPI| image:: https://img.shields.io/pypi/v/datasette.svg
:target: https://pypi.org/project/datasette/
.. |Changelog| image:: https://img.shields.io/github/v/release/simonw/datasette?include_prereleases&label=changelog
:target: https://datasette.readthedocs.io/en/stable/changelog.html
.. |Python 3.x| image:: https://img.shields.io/pypi/pyversions/datasette.svg?logo=python&logoColor=white
:target: https://pypi.org/project/datasette/
.. |Travis CI| image:: https://travis-ci.org/simonw/datasette.svg?branch=master
:target: https://travis-ci.org/simonw/datasette
.. |License| image:: https://img.shields.io/badge/license-Apache%202.0-blue.svg
:target: https://github.com/simonw/datasette/blob/master/LICENSE
.. |docker: datasette| image:: https://img.shields.io/badge/docker-datasette-blue
:target: https://hub.docker.com/r/datasetteproject/datasette
New tagline: 'A tool for exploring and publishing data'
2018-07-10 18:57:54 -07:00
*A tool for exploring and publishing data*
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
More human friendly 'what is Datasette' intro text
2018-11-04 22:04:23 -08:00
Datasette is a tool for exploring and publishing data. It helps people take data of any shape or size and publish that as an interactive, explorable website and accompanying API.
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
Examples of things you can do with plugins
2019-11-27 11:19:11 -08:00
Datasette is aimed at data journalists, museum curators, archivists, local governments and anyone else who has data that they wish to share with the world. It is part of a :ref:`wider ecosystem of tools and plugins <ecosystem>` dedicated to making working with structured data as productive as possible.
More human friendly 'what is Datasette' intro text
2018-11-04 22:04:23 -08:00
Another link to Glitch
2019-05-16 06:26:46 -07:00
`Explore a demo <https://fivethirtyeight.datasettes.com/fivethirtyeight>`__, watch `a presentation about the project <https://static.simonwillison.net/static/2018/pybay-datasette/>`__ or :ref:`glitch`.
More human friendly 'what is Datasette' intro text
2018-11-04 22:04:23 -08:00
More examples: https://github.com/simonw/datasette/wiki/Datasettes
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
Contents
--------
.. toctree::
register_routes() plugin hook (#819) Fixes #215
2020-06-08 20:12:06 -07:00
:maxdepth: 3
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
Moved getting started into separate docs page
2017-11-30 10:27:00 -08:00
getting_started
Re-ordered documentation index page
2019-05-15 22:14:33 -07:00
installation
ecosystem
Docs for IndexView, TableView, RowView, closes #299 Also removed xfail from test_view_classes_are_documented, so any future *View classes that are added without documentation will cause the tests to fail.
2018-07-27 21:21:42 -07:00
pages
Docs for datasette publish and package, closes #337 Also introduced a new mechanism for ensuring the --help examples in the documentation reflect the current output of the --help commands, via a new update-docs-help.sh script. Closes #336
2018-07-10 19:04:13 -07:00
publish
Database/Table views inherit source/license/source_url/license_url metadata If you set the source_url/license_url/source/license fields in your root metadata those values will now be inherited all the way down to the database and table templates. The title/description are NOT inherited. Also added unit tests for the HTML generated by the metadata. Refs #185
2018-03-27 09:18:32 -07:00
json_api
Documentation for custom SQL queries http://datasette.readthedocs.io/en/latest/sql_queries.html Closes #20
2017-12-05 09:43:59 -08:00
sql_queries
Added /-/permissions debug tool, closes #788 Also started the authentication.rst docs page, refs #786. Part of authentication work, refs #699.
2020-05-31 22:00:36 -07:00
authentication
New performance documentation, closes #421
2019-05-18 22:31:03 -07:00
performance
Docs for CSV export, refs #266
2018-06-18 07:12:21 -07:00
csv_export
Initial implementation of facets, plus tests and docs Refs #255
2018-05-12 19:29:06 -03:00
facets
Documentation for SQLite full-text search support, closes #253
2018-05-12 09:06:38 -03:00
full_text_search
Initial documentation on using SpatiaLite https://datasette.readthedocs.io/en/latest/spatialite.html
2018-05-26 11:04:09 -07:00
spatialite
Documentation for metadata.json and "datasette skeleton" command http://datasette.readthedocs.io/en/latest/metadata.html Closes #166
2017-12-07 09:19:35 -08:00
metadata
Renamed --limit to --config, added --help-config, closes #274 Removed the --page_size= argument to datasette serve in favour of: datasette serve --config default_page_size:50 mydb.db Added new help section: $ datasette --help-config Config options: default_page_size Default page size for the table view (default=100) max_returned_rows Maximum rows that can be returned from a table or custom query (default=1000) sql_time_limit_ms Time limit for a SQL query in milliseconds (default=1000) default_facet_size Number of values to return for requested facets (default=30) facet_time_limit_ms Time limit for calculating a requested facet (default=200) facet_suggest_time_limit_ms Time limit for calculating a suggested facet (default=50)
2018-05-20 10:01:49 -07:00
config
Added docs for introspection endpoints https://datasette.readthedocs.io/en/latest/introspection.html
2018-05-20 14:28:53 -07:00
introspection
Re-ordered docs index page
2017-12-06 10:27:50 -08:00
custom_templates
Initial documentation for plugins, closes #213 https://datasette.readthedocs.io/en/latest/plugins.html
2018-04-16 08:12:09 -07:00
plugins
.execute_write() and .execute_write_fn() methods on Database (#683) Closes #682.
2020-02-24 20:45:08 -08:00
internals
Started contributing docs: setting up a dev environment https://datasette.readthedocs.io/en/latest/contributing.html
2018-10-27 10:12:19 -07:00
contributing
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
changelog
Reference in a new issue Copy permalink