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
sphinx-issues # Sphinx roles providing support for linking GitHub
sphinxcontrib-apidoc >= 0.3.0
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 ``myst-parser`` to enable Markdown support in Sphinx documentation,
and linked the Code of Conduct and License in the docs sidebar
-- by :user:`julianz-`.
1 change: 1 addition & 0 deletions docs/code_of_conduct.md
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',
'sphinx_issues', # implements `:issue:`, `:pr:` and other GH-related roles
'sphinx_tabs.tabs',
'sphinxcontrib.apidoc',
Expand Down
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Welcome to Cheroot documentation!
:hidden:

contributing/guidelines
Code of Conduct <code_of_conduct>
License <license>

.. toctree::
:caption: Maintenance
Expand Down
4 changes: 4 additions & 0 deletions docs/license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# License

```{include} ../LICENSE.md
```
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ docs = [

# local
"furo",
"myst-parser",
# `scm_tag_titles_ext` extension dep in docs/
"python-dateutil",
"sphinxcontrib-apidoc >= 0.3.0",
Expand Down
Loading