Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions dependencies/tox-docs.in
Original file line number Diff line number Diff line change
Expand Up @@ -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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the future: modern versions of Sphinx can do this natively, we should try to migrate some day.

sphinxcontrib-towncrier
3 changes: 3 additions & 0 deletions docs/changelog-fragments.d/835.contrib.rst
Original file line number Diff line number Diff line change
@@ -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-`.
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
2 changes: 2 additions & 0 deletions docs/contributing/code_of_conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
```{include} ../../.github/CODE_OF_CONDUCT.md
```
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Welcome to Cheroot documentation!
:hidden:

contributing/guidelines
contributing/code_of_conduct

.. toctree::
:caption: Maintenance
Expand Down
1 change: 1 addition & 0 deletions docs/spelling_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ refactoring
refactorings
Sep
sep
sexualized
signalling
Sigstore
Solaris
Expand Down
Loading