1  # -*- coding: utf-8 -*-
  2  #
  3  # Configuration file for the Sphinx documentation builder.
  4  #
  5  # This file does only contain a selection of the most common options. For a
  6  # full list see the documentation:
  7  # http://www.sphinx-doc.org/en/master/config
  8  
  9  # -- Path setup --------------------------------------------------------------
 10  
 11  # If extensions (or modules to document with autodoc) are in another directory,
 12  # add these directories to sys.path here. If the directory is relative to the
 13  # documentation root, use os.path.abspath to make it absolute, like shown here.
 14  #
 15  import os
 16  import sys
 17  sys.path.insert(0, os.path.abspath('../..'))
 18  
 19  
 20  # -- Project information -----------------------------------------------------
 21  
 22  project = 'PDKMaster'
 23  copyright = 'PDKMaster developers'
 24  author = 'Staf Verhaegen'
 25  
 26  # The short X.Y version
 27  version = ''
 28  # The full version, including alpha/beta/rc tags
 29  release = ''
 30  
 31  
 32  # -- General configuration ---------------------------------------------------
 33  
 34  # If your documentation needs a minimal Sphinx version, state it here.
 35  #
 36  # needs_sphinx = '1.0'
 37  
 38  # Add any Sphinx extension module names here, as strings. They can be
 39  # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 40  # ones.
 41  extensions = [
 42      'sphinx.ext.autodoc',
 43      'sphinx.ext.todo',
 44      'sphinx.ext.mathjax',
 45      'sphinx.ext.viewcode',
 46      "sphinx.ext.napoleon",
 47      "sphinx.ext.autodoc.typehints",
 48  ]
 49  
 50  # Add any paths that contain templates here, relative to this directory.
 51  # templates_path = ['_templates']
 52  
 53  # The suffix(es) of source filenames.
 54  # You can specify multiple suffix as a list of string:
 55  #
 56  # source_suffix = ['.rst', '.md']
 57  source_suffix = '.rst'
 58  
 59  # The master toctree document.
 60  master_doc = 'index'
 61  
 62  # The language for content autogenerated by Sphinx. Refer to documentation
 63  # for a list of supported languages.
 64  #
 65  # This is also used if you do content translation via gettext catalogs.
 66  # Usually you set "language" from the command line for these cases.
 67  language = 'en'
 68  
 69  # List of patterns, relative to source directory, that match files and
 70  # directories to ignore when looking for source files.
 71  # This pattern also affects html_static_path and html_extra_path.
 72  exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 73  
 74  # The name of the Pygments (syntax highlighting) style to use.
 75  pygments_style = None
 76  
 77  
 78  # -- Options for HTML output -------------------------------------------------
 79  
 80  # The theme to use for HTML and HTML Help pages.  See the documentation for
 81  # a list of builtin themes.
 82  #
 83  html_theme = 'classic'
 84  
 85  # Theme options are theme-specific and customize the look and feel of a theme
 86  # further.  For a list of options available for each theme, see the
 87  # documentation.
 88  #
 89  html_theme_options = {
 90      'bgcolor': '#fff',
 91      'textcolor': '#000',
 92      'linkcolor': '#394',
 93      'visitedlinkcolor': '#394',
 94      'footertextcolor': '#fff',
 95      'footerbgcolor': '#4B5',
 96      'sidebartextcolor': '#000',
 97      'sidebarlinkcolor': '#333',
 98      'sidebarbgcolor': '#4B5',
 99      'relbartextcolor': '#000',
100      'relbarlinkcolor': '#000',
101      'relbarbgcolor': '#4B5',
102      'headtextcolor': '#394',
103      'codebgcolor': '#ddd',
104  }
105  
106  # Add any paths that contain custom static files (such as style sheets) here,
107  # relative to this directory. They are copied after the builtin static files,
108  # so a file named "default.css" will overwrite the builtin "default.css".
109  # html_static_path = ['_static']
110  
111  # Custom sidebar templates, must be a dictionary that maps document names
112  # to template names.
113  #
114  # The default sidebars (for documents that don't match any pattern) are
115  # defined by theme itself.  Builtin themes are using these templates by
116  # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
117  # 'searchbox.html']``.
118  #
119  # html_sidebars = {}
120  
121  
122  # -- Options for HTMLHelp output ---------------------------------------------
123  
124  # Output file base name for HTML help builder.
125  htmlhelp_basename = 'PDKMasterdoc'
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, 'PDKMaster.tex', 'PDKMaster Documentation',
153       'Staf Verhaegen', '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, 'pdkmaster', 'PDKMaster 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, 'PDKMaster', 'PDKMaster Documentation',
174       author, 'PDKMaster', 'One line description of project.',
175       'Miscellaneous'),
176  ]
177  
178  
179  # -- Options for Epub output -------------------------------------------------
180  
181  # Bibliographic Dublin Core info.
182  epub_title = project
183  
184  # The unique identifier of the text. This can be a ISBN number
185  # or the project homepage.
186  #
187  # epub_identifier = ''
188  
189  # A unique identification for the text.
190  #
191  # epub_uid = ''
192  
193  # A list of files that should not be packed into the epub file.
194  epub_exclude_files = ['search.html']
195  
196  
197  # -- Extension configuration -------------------------------------------------
198  autodoc_member_order = 'bysource'
199  napoleon_custom_sections = ("API Notes",)
200  
201  # -- Options for todo extension ----------------------------------------------
202  
203  # If true, `todo` and `todoList` produce output, else they produce nothing.
204  todo_include_todos = True