Skip to content

[TASK] Bring the reST markup to the documented house style #570

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

Merged
linawolf merged 1 commit into from
Sep 14, 2026
Merged

[TASK] Bring the reST markup to the documented house style #570

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
12 changes: 6 additions & 6 deletions Documentation/Advanced/Format.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,16 +57,16 @@ reST vs. Markdown

Victor Zverovich makes the comparison:

According to John Gruber, the inventor of Markdown, “Markdown’s syntax is intended for one
purpose: to be used as a format for writing for the web.” and, in particular, it supports inline HTML.
reStructuredText on the other hand is specifically designed for writing technical documentation.
According to John Gruber, the inventor of Markdown, “Markdown’s syntax is intended for one
purpose: to be used as a format for writing for the web.” and, in particular, it supports inline HTML.
reStructuredText on the other hand is specifically designed for writing technical documentation.


readthedocs:

"It should be noted that Commonmark doesn’t support a lot of the concepts that RST lets you represent.
In particular, there is no standardized way in Commonmark to represent inline or block levels constructs.
So things like the toctree directive and :ref: markup don’t have an analog."
"It should be noted that Commonmark doesn’t support a lot of the concepts that RST lets you represent.
In particular, there is no standardized way in Commonmark to represent inline or block levels constructs.
So things like the toctree directive and :ref: markup don’t have an analog."

`Read the Docs & Sphinx now support Commonmark <https://blog.readthedocs.com/adding-markdown-support/>`__ (2015)

Expand Down
4 changes: 2 additions & 2 deletions Documentation/Advanced/Licenses.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ We keep that until something else may be decided somewhere in the future.

New manuals should be licensed under `Creative Commons BY 4.0`_.

.. _Open Publication License: https://www.opencontent.org/openpub/
.. _Creative Commons BY 4.0: https://creativecommons.org/licenses/by/4.0/
.. _Open Publication License: https://www.opencontent.org/openpub/
.. _Creative Commons BY 4.0: https://creativecommons.org/licenses/by/4.0/