Fix docs building

galaxyproject · Dec 2, 2024 · 1f91efa · 1f91efa
1 parent 4857d27
commit 1f91efa
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 10 deletions.
diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -14,7 +14,7 @@ coverage
 # For dev
 sphinx
 sphinx_rtd_theme
-recommonmark
+myst-parser
 
 # Used to check readme.
 readme

diff --git a/docs/conf.py b/docs/conf.py
@@ -30,13 +30,6 @@
 # version is used.
 sys.path.insert(0, project_root)
 
-from recommonmark.parser import CommonMarkParser
-import sphinx_rtd_theme
-
-source_parsers = {
-    '.md': CommonMarkParser,
-}
-
 import gxformat2 as project_module
 
 # -- General configuration ---------------------------------------------
@@ -46,7 +39,7 @@
 
 # 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.autodoc', 'sphinx.ext.viewcode']
+extensions = ["myst_parser", 'sphinx.ext.autodoc', 'sphinx.ext.viewcode']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -118,7 +111,6 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 html_theme = "sphinx_rtd_theme"
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # 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

diff --git a/docs/index.rst b/docs/index.rst
@@ -14,6 +14,7 @@ Contents:
    readme
    installation
    conduct
+   design
    contributing
    developing
    history
-Original file line number
+Diff line change
@@ Expand Up / @@ -14,6 +14,7 @@ Contents: @@
        readme
        installation
        conduct
+       design
        contributing
        developing
        history
@@ Expand Down @@