Skip to content

Commit 5100d87

Browse files
committed
Hide the TOC and reword a few minor docs contents.
Furo already puts contents in the sidebar, no need to repeat.
1 parent 1e630ba commit 5100d87

File tree

3 files changed

+7
-11
lines changed

3 files changed

+7
-11
lines changed

README.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,6 @@
2727

2828
An implementation-agnostic implementation of JSON reference resolution.
2929

30-
In other words, a way for e.g. JSON Schema tooling to resolve the ``$ref`` keyword across all drafts (without needing to implement support themselves).
31-
32-
What's here is inspired in part by the budding JSON `reference specification(s) <https://github.com/json-schema-org/referencing>`_ (currently housed within the JSON Schema organization but intended to be more broadly applicable), which intend to detach some of the referencing behavior from JSON Schema's own specifications.
30+
In other words, a way for e.g. JSON Schema tooling to resolve the ``$ref`` keyword across all drafts without needing to implement support themselves.
3331

3432
See `the documentation <https://referencing.readthedocs.io/>`_ for more details.

docs/index.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
.. include:: ../README.rst
1+
An implementation-agnostic implementation of JSON reference resolution.
22

3-
4-
Contents
5-
--------
3+
In other words, a way for e.g. JSON Schema tooling to resolve the ``$ref`` keyword across all drafts without needing to implement support themselves.
64

75
.. toctree::
86
:glob:
9-
:maxdepth: 2
7+
:hidden:
108

119
intro
1210
external-retrieval

docs/intro.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
=======================================
2-
Introduction to the ``referencing`` API
3-
=======================================
1+
============
2+
Introduction
3+
============
44

55
When authoring JSON documents, it is often useful to be able to reference other JSON documents, or to reference subsections of other JSON documents.
66

0 commit comments

Comments
 (0)