Skip to content

Commit 67515c8

Browse files
committed
Add links and flatten changelog toctree
Update furo to support edit button, add edit button and repo links. Make the changelog appear as a non-nested item in the toctree setup.
1 parent b2c710a commit 67515c8

File tree

3 files changed

+16
-1
lines changed

3 files changed

+16
-1
lines changed

docs/conf.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,8 @@
2020
html_theme = "furo"
2121
pygments_style = "friendly"
2222
pygments_dark_style = "monokai" # this is a furo-specific option
23+
html_theme_options = {
24+
"source_repository": "https://github.com/python-jsonschema/check-jsonschema/",
25+
"source_branch": "main",
26+
"source_directory": "docs/",
27+
}

docs/index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ A JSON Schema CLI and `pre-commit <https://pre-commit.com/>`_ hook built on
77
The schema may be specified as a local or remote (HTTP or HTTPS) file.
88
Remote files are automatically downloaded and cached if possible.
99

10+
The source code is hosted in `a GitHub repo
11+
<https://github.com/python-jsonschema/check-jsonschema/>`_, and bugs and
12+
features are tracked in the associated `issue tracker
13+
<https://github.com/python-jsonschema/check-jsonschema/issues/>`_.
14+
1015
.. toctree::
1116
:maxdepth: 2
1217
:caption: Contents:
@@ -16,4 +21,9 @@ Remote files are automatically downloaded and cached if possible.
1621
precommit_usage
1722
optional_parsers
1823
faq
24+
25+
.. toctree::
26+
:maxdepth: 1
27+
:caption: Change History:
28+
1929
changelog

setup.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ dev =
4444
docs =
4545
sphinx<7
4646
sphinx-issues<4
47-
furo==2022.6.21
47+
furo==2022.12.07
4848

4949
[isort]
5050
profile = black

0 commit comments

Comments
 (0)