Skip to content

Commit

Permalink
Fixed some rST header warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
simonw committed Oct 12, 2023
1 parent a4b401f commit 11f7fd3
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 25 deletions.
20 changes: 7 additions & 13 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ Here's a full example of all the valid configuration options that can exist insi
}
}
}
.. [[[end]]]
.. _configuration_reference_settings:
Expand Down Expand Up @@ -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
19 changes: 7 additions & 12 deletions docs/metadata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.

Expand All @@ -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``
Expand Down

0 comments on commit 11f7fd3

Please sign in to comment.