diff options
| -rw-r--r-- | requirements.txt | 1 | ||||
| -rw-r--r-- | sources/pyside6/doc/conf.py.in | 23 | ||||
| -rw-r--r-- | sources/shiboken6/doc/conf.py.in | 24 |
3 files changed, 44 insertions, 4 deletions
diff --git a/requirements.txt b/requirements.txt index 78fc79e67..50cb54b95 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,6 +3,7 @@ packaging build==0.7 sphinx sphinx-panels +myst-parser six wheel>=0.35 PyOpenGL diff --git a/sources/pyside6/doc/conf.py.in b/sources/pyside6/doc/conf.py.in index cf77223a1..730c36827 100644 --- a/sources/pyside6/doc/conf.py.in +++ b/sources/pyside6/doc/conf.py.in @@ -30,7 +30,23 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.ifconfig', 'sphinx.ext.coverage', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.graphviz', 'inheritance_diagram', 'pysideinclude', 'sphinx.ext.viewcode', - 'sphinx_panels', 'sphinx_copybutton'] + 'sphinx_panels', 'sphinx_copybutton', 'myst_parser'] + +myst_enable_extensions = [ + "amsmath", + "colon_fence", + "deflist", + "dollarmath", + "fieldlist", + "html_admonition", + "html_image", + "replacements", + "smartquotes", + "strikethrough", + "substitution", + "tasklist", +] +myst_heading_anchors = 6 output_format='@DOC_OUTPUT_FORMAT@' @@ -46,7 +62,10 @@ rst_epilog = """ templates_path = ['@CMAKE_CURRENT_SOURCE_DIR@/_templates'] # The suffix of source filenames. -source_suffix = '.rst' +source_suffix = { + '.rst': 'restructuredtext', + '.md': 'markdown', +} # The encoding of source files. source_encoding = 'utf-8' diff --git a/sources/shiboken6/doc/conf.py.in b/sources/shiboken6/doc/conf.py.in index 5da9d3010..3746f4fa2 100644 --- a/sources/shiboken6/doc/conf.py.in +++ b/sources/shiboken6/doc/conf.py.in @@ -27,7 +27,24 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.ifconfig', 'sphinx.ext.coverage', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.graphviz', 'sphinx.ext.viewcode', - 'sphinx_panels', 'sphinx_copybutton'] + 'sphinx_panels', 'sphinx_copybutton', + 'myst_parser'] + +myst_enable_extensions = [ + "amsmath", + "colon_fence", + "deflist", + "dollarmath", + "fieldlist", + "html_admonition", + "html_image", + "replacements", + "smartquotes", + "strikethrough", + "substitution", + "tasklist", +] +myst_heading_anchors = 6 output_format='@DOC_OUTPUT_FORMAT@' @@ -43,7 +60,10 @@ rst_epilog = """ templates_path = ['@CMAKE_CURRENT_SOURCE_DIR@/_templates'] # The suffix of source filenames. -source_suffix = '.rst' +source_suffix = { + '.rst': 'restructuredtext', + '.md': 'markdown', +} # The encoding of source files. source_encoding = 'utf-8' |