Skip to content
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

Jump to bottom

MAINT: Switch markdown from recommonmark to MySt-parser #139

Merged
merged 1 commit into from
Aug 18, 2023
+5 −14
Merged

MAINT: Switch markdown from recommonmark to MySt-parser #139

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
10 changes: 1 addition & 9 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@
# sys.path.insert(0, os.path.abspath('.'))
from distutils.version import LooseVersion

from recommonmark.transform import AutoStructify

import sphinx_material

FORCE_CLASSIC = os.environ.get("SPHINX_MATERIAL_FORCE_CLASSIC", False)
Expand Down Expand Up @@ -49,10 +47,10 @@
"sphinx.ext.mathjax",
"sphinx.ext.viewcode",
"nbsphinx",
"recommonmark",
"sphinx_markdown_tables",
"sphinx_copybutton",
"sphinx_search.extension",
"myst_parser",
]

autosummary_generate = True
Expand Down Expand Up @@ -161,12 +159,6 @@

# Enable eval_rst in markdown
def setup(app):
app.add_config_value(
"recommonmark_config",
{"enable_math": True, "enable_inline_math": True, "enable_eval_rst": True},
True,
)
app.add_transform(AutoStructify)
app.add_object_type(
"confval",
"confval",
Expand Down
5 changes: 2 additions & 3 deletions docs/markdown.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Markdown

Sphinx can be configured to use markdown using the [recommonmark](https://github.com/readthedocs/recommonmark)
extension. recommonmark is strict and does not natively support tables or common extensions
to markdown.
Sphinx can be configured to use markdown using the [MyST-parser](https://github.com/executablebooks/MyST-Parser)
extension.

---

Expand Down
4 changes: 2 additions & 2 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jupyter_client
notebook
nbconvert
ipykernel
recommonmark
myst-parser
sphinx_markdown_tables
sphinx-copybutton
readthedocs-sphinx-search
readthedocs-sphinx-search
Loading