Skip to content

Add MyST-Parser and link community files in docs sidebar #835

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
julianz- wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add MyST-Parser and link community files in docs sidebar #835

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
View file
Open in desktop
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

@webknjaz webknjaz Jul 7, 2026

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.

@julianz- julianz- Jul 13, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Good to know.

sphinxcontrib-towncrier
3 changes: 3 additions & 0 deletions docs/changelog-fragments.d/835.contrib.rst
View file
Open in desktop
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

@webknjaz webknjaz Jul 12, 2026

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.

Can we make that Code of Conduct a link? Would a :ref: work? Or something similar?

@webknjaz webknjaz Jul 14, 2026

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.

@julianz- as an alternative, this should work

Suggested change
and linked the Code of Conduct in the docs sidebar
and linked the :doc:`Code of Conduct <contributing/code_of_conduct>` in the docs sidebar

-- by :user:`julianz-`.
1 change: 1 addition & 0 deletions docs/conf.py
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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

@webknjaz webknjaz Jul 12, 2026

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.

I didn't realize the CoC doc title was so long. Let's make the sidebar link shorter for now and maybe improve it later if needed.

Suggested change
contributing/code_of_conduct
Code of Conduct <contributing/code_of_conduct>

@julianz- julianz- Jul 13, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Sure. I also renamed "Private (dev) API autodoc" to "Internal API" in the sidebar as I thought the old name looks quite clunky. Happy to revert or use a different label if you prefer something else.

@webknjaz webknjaz Jul 14, 2026

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.

I'm not sure about the internal API. This isn't in the scope of the PR and I'm also not sure how to name it. That name might be long but it's clear that it's not for public consumption and it just a dump of something generated w/o careful curating. Maybe, once we get to documenting the public API and pick the public and private bits apart, into different sections, it'll make sense to thing of better naming as a part of that move.

@julianz- julianz- Jul 14, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Calling it "Private" though seems counter intuitive. It's the whole API currently no?


.. toctree::
:caption: Maintenance
Expand Down
1 change: 1 addition & 0 deletions docs/spelling_wordlist.txt
View file
Open in desktop
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