diff options
| author | Dennis Oberst <dennis.oberst@qt.io> | 2022-12-16 12:38:26 +0100 |
|---|---|---|
| committer | Dennis Oberst <dennis.oberst@qt.io> | 2022-12-19 14:53:39 +0100 |
| commit | af381be0f80ee524eaeb4c21c5ef4fa10adba3c3 (patch) | |
| tree | 1113d59e1031109080fba8afa053969ef739e518 /sources/pyside6 | |
| parent | 7fef5eb1b5f7e565a97991ec40ec9df99b409b94 (diff) | |
Add Markdown support to Sphinx
It is now possible to write documentation in markdown which
gets processed by the MyST - Markdown Parser.
Change-Id: Id17eae32d2ad2b6895e2f8c406a4215b8316b4e1
Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/pyside6')
| -rw-r--r-- | sources/pyside6/doc/conf.py.in | 23 |
1 files changed, 21 insertions, 2 deletions
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' |