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

[MAINT] change m2r to m2r2 #909

Merged
merged 7 commits into from
Nov 18, 2024
Merged

[MAINT] change m2r to m2r2 #909

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
46865be
[skipci] change m2r to m2r2
jdkent Nov 16, 2024
f2165d9
[skip ci] add legacy extention
jdkent Nov 16, 2024
13cef9a
fix install
jdkent Nov 18, 2024
1690db8
[skip ci] version control docutils
jdkent Nov 18, 2024
ad6a155
[skip ci] exclude compatability package
jdkent Nov 18, 2024
63f27a6
[skip ci] use mermaid
jdkent Nov 18, 2024
59b7f96
[skip ci] add comment
jdkent Nov 18, 2024
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
4 changes: 3 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
from distutils.version import LooseVersion

import sphinx
from m2r import MdInclude
from m2r2 import MdInclude
from sphinx_gallery.sorting import FileNameSortKey

sys.path.insert(0, os.path.abspath(os.path.pardir))
Expand Down Expand Up @@ -55,6 +55,7 @@
"sphinx_gallery.gen_gallery", # example gallery
"sphinxarg.ext", # argparse
"sphinxcontrib.bibtex", # for foot-citations
"sphinxcontrib.mermaid", # for mermaid diagrams
"recommonmark", # markdown parser
]

Expand Down Expand Up @@ -227,6 +228,7 @@ def setup(app):
app.add_config_value("m2r_parse_relative_links", False, "env")
app.add_config_value("m2r_anonymous_references", False, "env")
app.add_config_value("m2r_disable_inline_math", False, "env")
app.add_config_value("m2r_use_mermaid", True, "env")
app.add_directive("mdinclude", MdInclude)


Expand Down
6 changes: 4 additions & 2 deletions setup.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,9 @@ gzip =
cbmr =
torch>=2.0 # for cbmr models
doc =
m2r
m2r2
matplotlib
mistune<2 # just temporary until m2r addresses this issue
mistune
pillow
recommonmark
seaborn
Expand All @@ -82,6 +82,8 @@ doc =
sphinx-gallery
sphinx_rtd_theme>=1.3.0
sphinxcontrib-bibtex
sphinxcontrib-mermaid
docutils>=0.18.1,<0.21 # https://github.com/orgs/sphinx-doc/discussions/13020
tests =
coverage
coveralls
Expand Down