diff --git a/requirements.txt b/requirements.txt --- a/requirements.txt +++ b/requirements.txt @@ -6,6 +6,6 @@ sphinxcontrib-images sphinxcontrib-programoutput sphinx-tabs -recommonmark sphinx_rtd_theme sphinx-click +myst-parser diff --git a/swh/docs/sphinx/conf.py b/swh/docs/sphinx/conf.py --- a/swh/docs/sphinx/conf.py +++ b/swh/docs/sphinx/conf.py @@ -29,6 +29,8 @@ "sphinx_rtd_theme", "sphinx.ext.graphviz", "sphinx_click.ext", + "myst_parser", + "sphinx.ext.todo", ] # Add any paths that contain templates here, relative to this directory. @@ -37,12 +39,7 @@ # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # -source_suffix = [".rst", ".md"] -# source_suffix = '.rst' - -source_parsers = { - ".md": "recommonmark.parser.CommonMarkParser", -} +source_suffix = ".rst" # The master toctree document. master_doc = "index" @@ -140,6 +137,9 @@ modindex_common_prefix = ["swh."] +# For the todo extension. Todo and todolist produce output only if this is True +todo_include_todos = True + # for the extlinks extension, sub-projects should fill that dict extlinks: Dict = {}