Debian Codegraph @

libs/CCAppCommon/QDarkStyleSheet/docs/conf.py

raw
1 # -*- coding: utf-8 -*-
2 #
3 # QDarkStyle documentation build configuration file, created by
4 # sphinx-quickstart on Tue May 8 14:23:26 2018.
5 #
6 # This file is execfile()d with the current directory set to its
7 # containing dir.
8 #
9 # Note that not all possible configuration values are present in this
10 # autogenerated file.
11 #
12 # All configuration values have a default; values that are commented out
13 # serve to show the default.
14
15 # If extensions (or modules to document with autodoc) are in another directory,
16 # add these directories to sys.path here. If the directory is relative to the
17 # documentation root, use os.path.abspath to make it absolute, like shown here.
18
19 import os
20 import sys
21
22 sys.path.insert(0, os.path.abspath('..'))
23
24 import qdarkstyle
25
26 # -- General configuration ------------------------------------------------
27
28 # If your documentation needs a minimal Sphinx version, state it here.
29 #
30 # needs_sphinx = '1.0'
31
32 # Add any Sphinx extension module names here, as strings. They can be
33 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
34 # ones.
35 extensions = ['sphinx.ext.autodoc',
36 'sphinx.ext.doctest',
37 'sphinx.ext.intersphinx',
38 'sphinx.ext.todo',
39 'sphinx.ext.coverage',
40 'sphinx.ext.mathjax',
41 'sphinx.ext.ifconfig',
42 'sphinx.ext.viewcode',
43 'sphinx.ext.githubpages',
44 'sphinx.ext.napoleon']
45
46 # Add any paths that contain templates here, relative to this directory.
47 templates_path = ['_templates']
48
49 # The suffix(es) of source filenames.
50 # You can specify multiple suffix as a list of string:
51 #
52 source_suffix = ['.rst']
53 #source_suffix = '.rst'
54
55 # The master toctree document.
56 master_doc = 'index'
57
58 # General information about the project.
59 project = 'QDarkStyle'
60 copyright = '2021, Colin Duquesnoy'
61 author = 'Colin Duquesnoy'
62
63 # The version info for the project you're documenting, acts as replacement for
64 # |version| and |release|, also used in various other places throughout the
65 # built documents.
66 #
67 # The short X.Y version.
68 version = qdarkstyle.__version__
69 # The full version, including alpha/beta/rc tags.
70 release = ''
71
72 # The language for content autogenerated by Sphinx. Refer to documentation
73 # for a list of supported languages.
74 #
75 # This is also used if you do content translation via gettext catalogs.
76 # Usually you set "language" from the command line for these cases.
77 language = None
78
79 # List of patterns, relative to source directory, that match files and
80 # directories to ignore when looking for source files.
81 # This patterns also effect to html_static_path and html_extra_path
82 exclude_patterns = []
83
84 # The name of the Pygments (syntax highlighting) style to use.
85 pygments_style = 'sphinx'
86
87 # If true, `todo` and `todoList` produce output, else they produce nothing.
88 todo_include_todos = True
89
90
91 # -- Options for HTML output ----------------------------------------------
92
93 # The theme to use for HTML and HTML Help pages. See the documentation for
94 # a list of builtin themes.
95 #
96 html_theme = 'sphinx_rtd_theme'
97
98 # Theme options are theme-specific and customize the look and feel of a theme
99 # further. For a list of options available for each theme, see the
100 # documentation.
101 #
102 # html_theme_options = {}
103
104 # Add any paths that contain custom static files (such as style sheets) here,
105 # relative to this directory. They are copied after the builtin static files,
106 # so a file named "default.css" will overwrite the builtin "default.css".
107 html_static_path = ['_static']
108
109 # Custom sidebar templates, must be a dictionary that maps document names
110 # to template names.
111 #
112 # This is required for the alabaster theme
113 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
114 html_sidebars = {
115 '**': [
116 'relations.html', # needs 'show_related': True theme option to display
117 'searchbox.html',
118 ]
119 }
120
121
122 # -- Options for HTMLHelp output ------------------------------------------
123
124 # Output file base name for HTML help builder.
125 htmlhelp_basename = 'QDarkStyledoc'
126
127
128 # -- Options for LaTeX output ---------------------------------------------
129
130 latex_elements = {
131 # The paper size ('letterpaper' or 'a4paper').
132 #
133 # 'papersize': 'letterpaper',
134
135 # The font size ('10pt', '11pt' or '12pt').
136 #
137 # 'pointsize': '10pt',
138
139 # Additional stuff for the LaTeX preamble.
140 #
141 # 'preamble': '',
142
143 # Latex figure (float) alignment
144 #
145 # 'figure_align': 'htbp',
146 }
147
148 # Grouping the document tree into LaTeX files. List of tuples
149 # (source start file, target name, title,
150 # author, documentclass [howto, manual, or own class]).
151 latex_documents = [
152 (master_doc, 'QDarkStyle.tex', 'QDarkStyle Documentation',
153 'Colin Duquesnoy', 'manual'),
154 ]
155
156
157 # -- Options for manual page output ---------------------------------------
158
159 # One entry per manual page. List of tuples
160 # (source start file, name, description, authors, manual section).
161 man_pages = [
162 (master_doc, 'qdarkstyle', 'QDarkStyle Documentation',
163 [author], 1)
164 ]
165
166
167 # -- Options for Texinfo output -------------------------------------------
168
169 # Grouping the document tree into Texinfo files. List of tuples
170 # (source start file, target name, title, author,
171 # dir menu entry, description, category)
172 texinfo_documents = [
173 (master_doc, 'QDarkStyle', 'QDarkStyle Documentation',
174 author, 'QDarkStyle', 'One line description of project.',
175 'Miscellaneous'),
176 ]
177
178
179 # Example configuration for intersphinx: refer to the Python standard library.
180 intersphinx_mapping = {'https://docs.python.org/': None}