From 11f7fd38a4aea01c8c75b85105b4a52989ea488a Mon Sep 17 00:00:00 2001 From: Simon Willison Date: Thu, 12 Oct 2023 15:05:02 -0700 Subject: [PATCH] Fixed some rST header warnings --- docs/configuration.rst | 20 +++++++------------- docs/metadata.rst | 19 +++++++------------ 2 files changed, 14 insertions(+), 25 deletions(-) diff --git a/docs/configuration.rst b/docs/configuration.rst index 4e10860247..a9f53f7616 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -118,6 +118,7 @@ Here's a full example of all the valid configuration options that can exist insi } } } + .. [[[end]]] .. _configuration_reference_settings: @@ -275,26 +276,19 @@ For database level or table level plugin configuration, nest it under the approp .. _configuration_reference_permissions: -Permissions Configuration -~~~~~~~~~~~~~~~~~~~~ - -TODO - - -.. _configuration_reference_authentication: -Authentication Configuration -~~~~~~~~~~~~~~~~~~~~ +Permissions configuration +~~~~~~~~~~~~~~~~~~~~~~~~~ TODO .. _configuration_reference_canned_queries: -Canned Queries Configuration -~~~~~~~~~~~~~~~~~~~~ +Canned queries configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ TODO .. _configuration_reference_css_js: -Extra CSS and JS Configuration -~~~~~~~~~~~~~~~~~~~~ +Extra CSS and JS configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ TODO diff --git a/docs/metadata.rst b/docs/metadata.rst index 07fc74d830..b4dc90f940 100644 --- a/docs/metadata.rst +++ b/docs/metadata.rst @@ -693,14 +693,14 @@ Here's an example of a ``metadata.yml`` file, re-using an example from :ref:`can .. _metadata_reference: -Metadata Reference ------------------------ +Metadata reference +------------------ A full reference of every supported option in a ``metadata.json`` or ``metadata.yaml`` file. -Top-level Metadata +Top-level metadata ~~~~~~~~~~~~~~~~~~ "Top-level" metadata refers to fields that can be specified at the root level of a metadata file. These attributes are meant to describe the entire Datasette instance. @@ -715,11 +715,8 @@ The following are the full list of allowed top-level metadata fields: - ``source`` - ``source_url`` - - -Database-level Metadata -~~~~~~~~~~~~~~~~~~ - +Database-level metadata +~~~~~~~~~~~~~~~~~~~~~~~ "Database-level" metadata refers to fields that can be specified for each database in a Datasette instance. These attributes should be listed under a database inside the `"databases"` field. @@ -732,15 +729,13 @@ The following are the full list of allowed database-level metadata fields: - ``about`` - ``about_url`` - -Table-level Metadata -~~~~~~~~~~~~~~~~~~ +Table-level metadata +~~~~~~~~~~~~~~~~~~~~ "Table-level" metadata refers to fields that can be specified for each table in a Datasette instance. These attributes should be listed under a specific table using the `"tables"` field. The following are the full list of allowed table-level metadata fields: - - ``source`` - ``source_url`` - ``license``