Recommonmark -> MyST Parser
MODIFY
docs/doc-requirements.txt
docs/doc-requirements.txt
sphinx==4.0.2
-recommonmark==0.7.1
sphinxcontrib-autoprogram==0.1.7
pydata-sphinx-theme==0.6.3
+myst-parser==0.15.2

MODIFY
docs/source/conf.py
docs/source/conf.py
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-#
-# repo2docker documentation build configuration file, created by
-# sphinx-quickstart on Fri Jun 2 13:00:51 2017.
-#
-# This file is execfile()d with the current directory set to its
-# containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
-
-
# -- General configuration ------------------------------------------------
-# If your documentation needs a minimal Sphinx version, state it here.
-#
-# needs_sphinx = '1.0'
-
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
-extensions = ["sphinx.ext.extlinks", "sphinxcontrib.autoprogram", "recommonmark"]
+extensions = ["sphinx.ext.extlinks", "sphinxcontrib.autoprogram", "myst_parser"]
extlinks = {
"issue": ("https://github.com/jupyterhub/repo2docker/issues/%s", "Issue #"),
@@ -43,15 +15,8 @@ extlinks = {
templates_path = ["_templates"]
-from recommonmark.transform import AutoStructify
-
-
def setup(app):
app.add_css_file("custom.css") # may also be a URL
- app.add_config_value(
- "recommonmark_config", {"auto_toc_tree_section": "Contents"}, True
- )
- app.add_transform(AutoStructify)
# The suffix(es) of source filenames.
@@ -108,9 +73,12 @@ pygments_style = "sphinx"
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
-# repo2docker Logo
-html_logo = "_static/images/logo.png"
-html_favicon = "_static/images/favicon.ico"
+# MyST configuration
+
+myst_enable_extensions = [
+ "colon_fence",
+]
+
# -- Options for HTML output ----------------------------------------------
@@ -118,6 +86,8 @@ html_favicon = "_static/images/favicon.ico"
# a list of builtin themes.
#
html_theme = "pydata_sphinx_theme"
+html_logo = "_static/images/logo.png"
+html_favicon = "_static/images/favicon.ico"
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the

Recommonmark -> MyST Parser