diff options
Diffstat (limited to 'sources/pyside6/doc/conf.py.in')
| -rw-r--r-- | sources/pyside6/doc/conf.py.in | 61 |
1 files changed, 43 insertions, 18 deletions
diff --git a/sources/pyside6/doc/conf.py.in b/sources/pyside6/doc/conf.py.in index 0c2593147..e195d227f 100644 --- a/sources/pyside6/doc/conf.py.in +++ b/sources/pyside6/doc/conf.py.in @@ -13,7 +13,6 @@ import sys import os -from pathlib import Path # 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 @@ -27,12 +26,28 @@ if @HAS_WEBENGINE_WIDGETS@: # 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.todo', 'sphinx.ext.graphviz', 'inheritance_diagram', 'pysideinclude'] 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_design', 'sphinx_copybutton', 'myst_parser', 'sphinx_tags', + 'sphinx_toolbox.decorators'] + +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@' @@ -48,7 +63,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' @@ -60,7 +78,7 @@ master_doc = 'index' # General information about the project. project = u'PySide' -copyright = u'2021 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 (https://www.gnu.org/licenses/fdl.html) as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.' +copyright = u'2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 (https://www.gnu.org/licenses/fdl.html) as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. @@ -87,7 +105,7 @@ release = '@BINDING_API_VERSION_FULL@' # for source files. exclude_patterns = ['_build', 'extras', - ] + '**README.md'] # The reST default role (used for this markup: `text`) to use for all documents. #default_role = None @@ -121,17 +139,22 @@ html_theme = 'furo' # further. For a list of options available for each theme, see the # documentation. html_theme_options = { + # FIXME: This option is currently enable because on the 'requirements-doc.txt' + # We are using a fork of the theme, to include this new option. + # This needs to be removed once the functionality is either upstreamed, + # or a similar option is provided. + "collapse_navbar": True, "dark_css_variables": { - "color-brand-primary": "#66689d", - "color-brand-content": "#66689d", - "color-admonition-title--important": "#41cd52", + "color-brand-primary": "#2cde85", + "color-brand-content": "#2cde85", + "color-admonition-title--important": "#2cde85", "color-admonition-title-background--important": "#474b53", "font-stack": "'Titillium Web', sans-serif", }, "light_css_variables": { - "color-brand-primary": "#66689d", - "color-brand-content": "#41cd52", - "color-admonition-title--important": "#41cd52", + "color-brand-primary": "#27138b", + "color-brand-content": "#27138b", + "color-admonition-title--important": "#27138b", "font-stack": "'Titillium Web', sans-serif", }, } @@ -141,7 +164,7 @@ html_theme_path = ['@CMAKE_CURRENT_SOURCE_DIR@/_themes'] # The name for this set of Sphinx documents. If None, it defaults to # "<project> v<release> documentation". -html_title = u'Qt for Python' +html_title = 'Qt for Python' # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None @@ -153,7 +176,7 @@ html_logo = "@CMAKE_CURRENT_SOURCE_DIR@/_static/qtforpython.png" # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +html_favicon = "_static/qtforpython.ico" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -205,7 +228,7 @@ intersphinx_mapping = {'shiboken6': ('shiboken6','@SHIBOKEN_INTERSPHINX_FILE@')} add_module_names = False # Skip some warnings when building the documentation with -# 'build_rst_docs' due to the lack of qdoc generated files, in charge +# 'build_base_docs' due to the lack of qdoc generated files, in charge # of sphinx modules (autodoc) and references. if @SKIP_SPHINX_WARNINGS@: suppress_warnings = ["autodoc", "autodoc.import_object", "ref.ref"] @@ -213,7 +236,9 @@ if @SKIP_SPHINX_WARNINGS@: # -- Options for qthelp output --------------------------------------------------- qthelp_theme = 'pysidedocs_qthelp' -# Sphinx Panels color for inactive tab -panels_css_variables = { - "tabs-color-label-inactive": "rgba(116, 116, 116, 1.0)", +# for example tagging based on supported platforms +tags_create_tags = True +tags_create_badges = True +tags_badge_colors = { + "Android": "info", } |