Wed, 16 May 2018 10:53:51 +0200
convert doc to sphinx
92 | 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 = 'pygpibtoolkit' | |
23 | copyright = '2018, David Douard' | |
24 | author = 'David Douard' | |
25 | ||
26 | # The short X.Y version | |
27 | version = '' | |
28 | # The full version, including alpha/beta/rc tags | |
29 | release = '0.1.0' | |
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.viewcode', | |
45 | ] | |
46 | ||
47 | # Add any paths that contain templates here, relative to this directory. | |
48 | templates_path = ['_templates'] | |
49 | ||
50 | # The suffix(es) of source filenames. | |
51 | # You can specify multiple suffix as a list of string: | |
52 | # | |
53 | # source_suffix = ['.rst', '.md'] | |
54 | source_suffix = '.rst' | |
55 | ||
56 | # The master toctree document. | |
57 | master_doc = 'index' | |
58 | ||
59 | # The language for content autogenerated by Sphinx. Refer to documentation | |
60 | # for a list of supported languages. | |
61 | # | |
62 | # This is also used if you do content translation via gettext catalogs. | |
63 | # Usually you set "language" from the command line for these cases. | |
64 | language = None | |
65 | ||
66 | # List of patterns, relative to source directory, that match files and | |
67 | # directories to ignore when looking for source files. | |
68 | # This pattern also affects html_static_path and html_extra_path . | |
69 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] | |
70 | ||
71 | # The name of the Pygments (syntax highlighting) style to use. | |
72 | pygments_style = 'sphinx' | |
73 | ||
74 | ||
75 | # -- Options for HTML output ------------------------------------------------- | |
76 | ||
77 | # The theme to use for HTML and HTML Help pages. See the documentation for | |
78 | # a list of builtin themes. | |
79 | # | |
80 | html_theme = 'alabaster' | |
81 | ||
82 | # Theme options are theme-specific and customize the look and feel of a theme | |
83 | # further. For a list of options available for each theme, see the | |
84 | # documentation. | |
85 | # | |
86 | # html_theme_options = {} | |
87 | ||
88 | # Add any paths that contain custom static files (such as style sheets) here, | |
89 | # relative to this directory. They are copied after the builtin static files, | |
90 | # so a file named "default.css" will overwrite the builtin "default.css". | |
91 | html_static_path = ['_static'] | |
92 | ||
93 | # Custom sidebar templates, must be a dictionary that maps document names | |
94 | # to template names. | |
95 | # | |
96 | # The default sidebars (for documents that don't match any pattern) are | |
97 | # defined by theme itself. Builtin themes are using these templates by | |
98 | # default: ``['localtoc.html', 'relations.html', 'sourcelink.html', | |
99 | # 'searchbox.html']``. | |
100 | # | |
101 | # html_sidebars = {} | |
102 | ||
103 | ||
104 | # -- Options for HTMLHelp output --------------------------------------------- | |
105 | ||
106 | # Output file base name for HTML help builder. | |
107 | htmlhelp_basename = 'pygpibtoolkitdoc' | |
108 | ||
109 | ||
110 | # -- Options for LaTeX output ------------------------------------------------ | |
111 | ||
112 | latex_elements = { | |
113 | # The paper size ('letterpaper' or 'a4paper'). | |
114 | # | |
115 | # 'papersize': 'letterpaper', | |
116 | ||
117 | # The font size ('10pt', '11pt' or '12pt'). | |
118 | # | |
119 | # 'pointsize': '10pt', | |
120 | ||
121 | # Additional stuff for the LaTeX preamble. | |
122 | # | |
123 | # 'preamble': '', | |
124 | ||
125 | # Latex figure (float) alignment | |
126 | # | |
127 | # 'figure_align': 'htbp', | |
128 | } | |
129 | ||
130 | # Grouping the document tree into LaTeX files. List of tuples | |
131 | # (source start file, target name, title, | |
132 | # author, documentclass [howto, manual, or own class]). | |
133 | latex_documents = [ | |
134 | (master_doc, 'pygpibtoolkit.tex', 'pygpibtoolkit Documentation', | |
135 | 'David Douard', 'manual'), | |
136 | ] | |
137 | ||
138 | ||
139 | # -- Options for manual page output ------------------------------------------ | |
140 | ||
141 | # One entry per manual page. List of tuples | |
142 | # (source start file, name, description, authors, manual section). | |
143 | man_pages = [ | |
144 | (master_doc, 'pygpibtoolkit', 'pygpibtoolkit Documentation', | |
145 | [author], 1) | |
146 | ] | |
147 | ||
148 | ||
149 | # -- Options for Texinfo output ---------------------------------------------- | |
150 | ||
151 | # Grouping the document tree into Texinfo files. List of tuples | |
152 | # (source start file, target name, title, author, | |
153 | # dir menu entry, description, category) | |
154 | texinfo_documents = [ | |
155 | (master_doc, 'pygpibtoolkit', 'pygpibtoolkit Documentation', | |
156 | author, 'pygpibtoolkit', 'One line description of project.', | |
157 | 'Miscellaneous'), | |
158 | ] | |
159 | ||
160 | ||
161 | # -- Extension configuration ------------------------------------------------- | |
162 | ||
163 | # -- Options for todo extension ---------------------------------------------- | |
164 | ||
165 | # If true, `todo` and `todoList` produce output, else they produce nothing. | |
166 | todo_include_todos = True |