1- # -*- coding: utf-8 -*-
2- #
31# Configuration file for the Sphinx documentation builder.
42#
5- # This file does only contain a selection of the most common options. For a
6- # full list see the documentation:
3+ # This file only contains a selection of the most common options. For a full
4+ # list see the documentation:
75# http://www.sphinx-doc.org/en/master/config
86
97# -- Path setup --------------------------------------------------------------
1816
1917# -- Project information -----------------------------------------------------
2018
21- project = u''
22- copyright = u''
23- author = u''
24-
19+ project = ''
20+ copyright = ''
21+ author = 'C.W.'
2522# The short X.Y version
26- version = u' '
23+ version = '0.0.1 '
2724# The full version, including alpha/beta/rc tags
28- release = u''
29-
25+ release = '0.0.1'
3026
3127# -- General configuration ---------------------------------------------------
3228
33- # If your documentation needs a minimal Sphinx version, state it here.
34- #
35- # needs_sphinx = '1.0'
36-
3729# Add any Sphinx extension module names here, as strings. They can be
3830# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3931# ones.
5143# The master toctree document.
5244master_doc = ''
5345
54- # The language for content autogenerated by Sphinx. Refer to documentation
55- # for a list of supported languages.
56- #
57- # This is also used if you do content translation via gettext catalogs.
58- # Usually you set "language" from the command line for these cases.
59- language = ''
60-
6146# List of patterns, relative to source directory, that match files and
6247# directories to ignore when looking for source files.
6348# This pattern also affects html_static_path and html_extra_path.
6449exclude_patterns = []
6550
66- # The name of the Pygments (syntax highlighting) style to use.
67- pygments_style = None
68-
6951
7052# -- Options for HTML output -------------------------------------------------
7153
7456#
7557html_theme = 'alabaster'
7658
77- # Theme options are theme-specific and customize the look and feel of a theme
78- # further. For a list of options available for each theme, see the
79- # documentation.
80- #
81- # html_theme_options = {}
82-
8359# Add any paths that contain custom static files (such as style sheets) here,
8460# relative to this directory. They are copied after the builtin static files,
8561# so a file named "default.css" will overwrite the builtin "default.css".
86- html_static_path = ['static' ]
87-
88- # Custom sidebar templates, must be a dictionary that maps document names
89- # to template names.
90- #
91- # The default sidebars (for documents that don't match any pattern) are
92- # defined by theme itself. Builtin themes are using these templates by
93- # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
94- # 'searchbox.html']``.
95- #
96- # html_sidebars = {}
97-
98-
99- # -- Options for HTMLHelp output ---------------------------------------------
100-
101- # Output file base name for HTML help builder.
102- htmlhelp_basename = 'doc'
103-
104-
105- # -- Options for LaTeX output ------------------------------------------------
106-
107- latex_elements = {
108- # The paper size ('letterpaper' or 'a4paper').
109- #
110- # 'papersize': 'letterpaper',
111-
112- # The font size ('10pt', '11pt' or '12pt').
113- #
114- # 'pointsize': '10pt',
115-
116- # Additional stuff for the LaTeX preamble.
117- #
118- # 'preamble': '',
119-
120- # Latex figure (float) alignment
121- #
122- # 'figure_align': 'htbp',
123- }
124-
125- # Grouping the document tree into LaTeX files. List of tuples
126- # (source start file, target name, title,
127- # author, documentclass [howto, manual, or own class]).
128- latex_documents = [
129- (master_doc , '.tex' , u'' ,
130- u'' , 'manual' ),
131- ]
132-
133-
134- # -- Options for manual page output ------------------------------------------
135-
136- # One entry per manual page. List of tuples
137- # (source start file, name, description, authors, manual section).
138- man_pages = [
139- (master_doc , '' , u'' ,
140- [author ], 1 )
141- ]
142-
143-
144- # -- Options for Texinfo output ----------------------------------------------
145-
146- # Grouping the document tree into Texinfo files. List of tuples
147- # (source start file, target name, title, author,
148- # dir menu entry, description, category)
149- texinfo_documents = [
150- (master_doc , '' , u'' ,
151- author , '' , 'One line description of project.' ,
152- 'Miscellaneous' ),
153- ]
154-
155-
156- # -- Options for Epub output -------------------------------------------------
157-
158- # Bibliographic Dublin Core info.
159- epub_title = project
160-
161- # The unique identifier of the text. This can be a ISBN number
162- # or the project homepage.
163- #
164- # epub_identifier = ''
165-
166- # A unique identification for the text.
167- #
168- # epub_uid = ''
169-
170- # A list of files that should not be packed into the epub file.
171- epub_exclude_files = ['search.html' ]
62+ html_static_path = ['static' ]
0 commit comments