Skip to content

Commit e509231

Browse files
committed
Use MyST for markdown docs build
Moves away from recommonmark to MyST when building the markdown docs. Recommonmark is deprecated and no longer maintained in favour of MyST. The only change here is to swap up the dependencies and enable the MyST plugin in the conf.py. Signed-off-by: Jordan Borean <jborean93@gmail.com>
1 parent b674a57 commit e509231

File tree

3 files changed

+4
-16
lines changed

3 files changed

+4
-16
lines changed

Diff for: docs-requirements.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1+
myst-parser # For parsing markdown docs instead of rst
12
Sphinx >= 1.3.1
23
sphinx-autoapi
34
sphinx-rtd-theme >= 0.2.5b1
4-
recommonmark >= 0.4.0

Diff for: docs/custom_extensions/custom_recommonmark.py

-8
This file was deleted.

Diff for: docs/source/conf.py

+3-7
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@
2020

2121
sys.path.insert(0, os.path.abspath('../custom_extensions'))
2222

23-
from custom_recommonmark import AllCodeCommonMarkParser
24-
2523
# -- General configuration -----------------------------------------------------
2624

2725
# If your documentation needs a minimal Sphinx version, state it here.
@@ -30,6 +28,7 @@
3028
# Add any Sphinx extension module names here, as strings. They can be extensions
3129
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
3230
extensions = [
31+
'myst_parser',
3332
'sphinx.ext.autodoc',
3433
'sphinx.ext.intersphinx',
3534
'sphinx.ext.viewcode',
@@ -47,14 +46,11 @@
4746
# Add any paths that contain templates here, relative to this directory.
4847
templates_path = ['_templates']
4948

50-
# Parsers for different suffixes
51-
source_parsers = {
52-
'.md': AllCodeCommonMarkParser
53-
}
54-
5549
# The suffix of source filenames.
5650
source_suffix = ['.rst', '.md']
5751

52+
myst_all_links_external = True
53+
5854
# The encoding of source files.
5955
#source_encoding = 'utf-8-sig'
6056

0 commit comments

Comments
 (0)