Commit e509231

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 e509231Copy full SHA for e509231

File tree

3 files changed

-16

lines changed

docs-requirements.txt
docs
- custom_extensions
  - custom_recommonmark.py
- source
  - conf.py

3 files changed

-16

lines changed

`‎docs-requirements.txt`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
	`1`	`+myst-parser # For parsing markdown docs instead of rst`
`1`	`2`	`Sphinx >= 1.3.1`
`2`	`3`	`sphinx-autoapi`
`3`	`4`	`sphinx-rtd-theme >= 0.2.5b1`
`4`		`-recommonmark >= 0.4.0`

`‎docs/custom_extensions/custom_recommonmark.py`

Lines changed: 0 additions & 8 deletions

This file was deleted.

`‎docs/source/conf.py`

Lines changed: 3 additions & 7 deletions

Original file line number	Diff line number	Diff line change
`@@ -20,8 +20,6 @@`
`20`	`20`
`21`	`21`	`sys.path.insert(0, os.path.abspath('../custom_extensions'))`
`22`	`22`
`23`		`-from custom_recommonmark import AllCodeCommonMarkParser`
`24`		`-`
`25`	`23`	`# -- General configuration -----------------------------------------------------`
`26`	`24`
`27`	`25`	`# If your documentation needs a minimal Sphinx version, state it here.`
`@@ -30,6 +28,7 @@`
`30`	`28`	`# Add any Sphinx extension module names here, as strings. They can be extensions`
`31`	`29`	`# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.`
`32`	`30`	`extensions = [`
	`31`	`+ 'myst_parser',`
`33`	`32`	`'sphinx.ext.autodoc',`
`34`	`33`	`'sphinx.ext.intersphinx',`
`35`	`34`	`'sphinx.ext.viewcode',`
`@@ -47,14 +46,11 @@`
`47`	`46`	`# Add any paths that contain templates here, relative to this directory.`
`48`	`47`	`templates_path = ['_templates']`
`49`	`48`
`50`		`-# Parsers for different suffixes`
`51`		`-source_parsers = {`
`52`		`- '.md': AllCodeCommonMarkParser`
`53`		`-}`
`54`		`-`
`55`	`49`	`# The suffix of source filenames.`
`56`	`50`	`source_suffix = ['.rst', '.md']`
`57`	`51`
	`52`	`+myst_all_links_external = True`
	`53`	`+`
`58`	`54`	`# The encoding of source files.`
`59`	`55`	`#source_encoding = 'utf-8-sig'`
`60`	`56`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit e509231

File tree

3 files changed

3 files changed

`‎docs-requirements.txt`

`‎docs/custom_extensions/custom_recommonmark.py`

`‎docs/source/conf.py`

0 commit comments