From 4d6933aa674bdef0ac9bcbef3cb83647eb2d7092 Mon Sep 17 00:00:00 2001 From: julianz- <6255571+julianz-@users.noreply.github.com> Date: Sun, 5 Jul 2026 13:31:51 -0700 Subject: [PATCH] Add MyST-Parser and link community files in docs sidebar Add myst-parser to docs dependencies and Sphinx extensions, enabling Markdown support. Link the Code of Conduct and License in the docs sidebar as an initial test of the integration. --- dependencies/tox-docs.in | 1 + docs/changelog-fragments.d/835.contrib.rst | 3 +++ docs/code_of_conduct.md | 1 + docs/conf.py | 1 + docs/index.rst | 2 ++ docs/license.md | 4 ++++ pyproject.toml | 1 + 7 files changed, 13 insertions(+) create mode 100644 docs/changelog-fragments.d/835.contrib.rst create mode 120000 docs/code_of_conduct.md create mode 100644 docs/license.md diff --git a/dependencies/tox-docs.in b/dependencies/tox-docs.in index 930c3714f4..dbf30d9c93 100644 --- a/dependencies/tox-docs.in +++ b/dependencies/tox-docs.in @@ -6,6 +6,7 @@ jaraco.packaging >= 9 # first version to load meta through PEP 517 interface sphinx-tabs >= 1.1.0 furo +myst-parser sphinx-issues # Sphinx roles providing support for linking GitHub sphinxcontrib-apidoc >= 0.3.0 sphinxcontrib-towncrier diff --git a/docs/changelog-fragments.d/835.contrib.rst b/docs/changelog-fragments.d/835.contrib.rst new file mode 100644 index 0000000000..c4ffe5e71e --- /dev/null +++ b/docs/changelog-fragments.d/835.contrib.rst @@ -0,0 +1,3 @@ +Added ``myst-parser`` to enable Markdown support in Sphinx documentation, +and linked the Code of Conduct and License in the docs sidebar +-- by :user:`julianz-`. diff --git a/docs/code_of_conduct.md b/docs/code_of_conduct.md new file mode 120000 index 0000000000..5cda94459f --- /dev/null +++ b/docs/code_of_conduct.md @@ -0,0 +1 @@ +../.github/CODE_OF_CONDUCT.md \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index a8c4ecebed..3860c7b2d0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -35,6 +35,7 @@ 'sphinx.ext.intersphinx', # Third-party extensions: 'jaraco.packaging.sphinx', + 'myst_parser', 'sphinx_issues', # implements `:issue:`, `:pr:` and other GH-related roles 'sphinx_tabs.tabs', 'sphinxcontrib.apidoc', diff --git a/docs/index.rst b/docs/index.rst index 849181f30c..6c7fc8ad15 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,6 +15,8 @@ Welcome to Cheroot documentation! :hidden: contributing/guidelines + Code of Conduct + License .. toctree:: :caption: Maintenance diff --git a/docs/license.md b/docs/license.md new file mode 100644 index 0000000000..b6e36d7730 --- /dev/null +++ b/docs/license.md @@ -0,0 +1,4 @@ +# License + +```{include} ../LICENSE.md +``` diff --git a/pyproject.toml b/pyproject.toml index ff1fb40e56..1ebbb5e1e6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -81,6 +81,7 @@ docs = [ # local "furo", + "myst-parser", # `scm_tag_titles_ext` extension dep in docs/ "python-dateutil", "sphinxcontrib-apidoc >= 0.3.0",