diff --git a/dependencies/tox-docs.in b/dependencies/tox-docs.in index 930c3714f4..a05afe7ee3 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[linkify] # Markdown documents support w/ in-text link detector 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..f24b1503a0 --- /dev/null +++ b/docs/changelog-fragments.d/835.contrib.rst @@ -0,0 +1,3 @@ +Added :pypi:`myst-parser` to enable Markdown support in Sphinx documentation, +and linked the Code of Conduct in the docs sidebar +-- by :user:`julianz-`. diff --git a/docs/conf.py b/docs/conf.py index a8c4ecebed..1d526cae44 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -35,6 +35,7 @@ 'sphinx.ext.intersphinx', # Third-party extensions: 'jaraco.packaging.sphinx', + 'myst_parser', # extended markdown; https://pypi.org/p/myst-parser 'sphinx_issues', # implements `:issue:`, `:pr:` and other GH-related roles 'sphinx_tabs.tabs', 'sphinxcontrib.apidoc', diff --git a/docs/contributing/code_of_conduct.md b/docs/contributing/code_of_conduct.md new file mode 100644 index 0000000000..36beb23ba5 --- /dev/null +++ b/docs/contributing/code_of_conduct.md @@ -0,0 +1,2 @@ +```{include} ../../.github/CODE_OF_CONDUCT.md +``` diff --git a/docs/index.rst b/docs/index.rst index 849181f30c..a2ae5a7ef9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,6 +15,7 @@ Welcome to Cheroot documentation! :hidden: contributing/guidelines + contributing/code_of_conduct .. toctree:: :caption: Maintenance diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index 06b204518e..46561420c9 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -56,6 +56,7 @@ refactoring refactorings Sep sep +sexualized signalling Sigstore Solaris