From cd5203a0b615d31a0979bb1c9e47c78e510ce9c6 Mon Sep 17 00:00:00 2001 From: Jon Parise Date: Fri, 26 Jan 2024 20:17:23 -0800 Subject: [PATCH] Include the changelog in the Sphinx documentation We use the sphinx-mdinclude extension to include the Markdown-formatted CHANGELOG.md content into the reStructuredText-based documentation. --- CHANGELOG.md | 2 +- docs/changelog.rst | 1 + docs/conf.py | 1 + docs/index.rst | 5 +++++ pyproject.toml | 1 + 5 files changed, 9 insertions(+), 1 deletion(-) create mode 100644 docs/changelog.rst diff --git a/CHANGELOG.md b/CHANGELOG.md index 1e2d259..eb7e721 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ ## 0.12.0 - Unreleased ### Added -- All clients now support a user-provided [`httpx.Client`](https://www.python-httpx.org/api/#client) +- All clients now support a user-provided [httpx.Client](https://www.python-httpx.org/api/#client) objects. ## 0.11.0 - 2024-01-22 diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 0000000..6336d76 --- /dev/null +++ b/docs/changelog.rst @@ -0,0 +1 @@ +.. mdinclude:: ../CHANGELOG.md diff --git a/docs/conf.py b/docs/conf.py index d8df40a..49d3fe3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,6 +15,7 @@ "sphinx.ext.autodoc", "sphinx.ext.githubpages", "sphinx.ext.intersphinx", + "sphinx_mdinclude", ] intersphinx_mapping = { "python": ("https://docs.python.org/3/", None), diff --git a/docs/index.rst b/docs/index.rst index 960dc6d..b84ac3c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,6 +5,11 @@ Vesta Vesta is a `Vestaboard `_ client library for Python. It provides API clients and character encoding utilities. +.. toctree:: + :hidden: + + changelog + Installation ============ diff --git a/pyproject.toml b/pyproject.toml index 26ae865..f9a009b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -32,6 +32,7 @@ dependencies = [ docs = [ "Sphinx==7.2.2", "furo==2023.9.10", + "sphinx_mdinclude==0.5.3", ] lint = [ "ruff==0.1.11",