|
3 | 3 | 'Scaffolding mobans for your Python project.' +
|
4 | 4 | ''
|
5 | 5 | )
|
6 |
| -# -*- coding: utf-8 -*- |
7 |
| -# |
8 | 6 | # Configuration file for the Sphinx documentation builder.
|
9 | 7 | #
|
10 |
| -# This file does only contain a selection of the most common options. For a |
11 |
| -# full list see the documentation: |
| 8 | +# This file only contains a selection of the most common options. For a full |
| 9 | +# list see the documentation: |
12 | 10 | # http://www.sphinx-doc.org/en/master/config
|
13 | 11 |
|
14 | 12 | # -- Path setup --------------------------------------------------------------
|
|
23 | 21 |
|
24 | 22 | # -- Project information -----------------------------------------------------
|
25 | 23 |
|
26 |
| -project = u'pypi-mobans-pkg' |
27 |
| -copyright = u'2018 Onni Software Ltd.' |
28 |
| -author = u'C.W.' |
| 24 | +project = '' |
| 25 | +copyright = '' |
| 26 | +author = 'Onni Software Ltd. and its contributors' |
29 | 27 |
|
30 | 28 | # The short X.Y version
|
31 |
| -version = u'0.0.1' |
| 29 | +version = '0.0.2.1' |
32 | 30 | # The full version, including alpha/beta/rc tags
|
33 |
| -release = u'0.0.1' |
| 31 | +release = '0.0.2.1' |
34 | 32 |
|
35 | 33 |
|
36 | 34 | # -- General configuration ---------------------------------------------------
|
37 | 35 |
|
38 |
| -# If your documentation needs a minimal Sphinx version, state it here. |
39 |
| -# |
40 |
| -# needs_sphinx = '1.0' |
41 |
| - |
42 | 36 | # Add any Sphinx extension module names here, as strings. They can be
|
43 | 37 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
44 | 38 | # ones.
|
45 |
| -extensions = [ |
46 |
| - 'sphinx.ext.autodoc', |
47 |
| - 'sphinx.ext.doctest', |
48 |
| - 'sphinx.ext.intersphinx', |
49 |
| - 'sphinx.ext.viewcode', |
50 |
| -] |
| 39 | +extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode',] |
51 | 40 |
|
52 | 41 | # Add any paths that contain templates here, relative to this directory.
|
53 | 42 | templates_path = ['_templates']
|
|
59 | 48 | source_suffix = '.rst'
|
60 | 49 |
|
61 | 50 | # The master toctree document.
|
62 |
| -master_doc = 'index' |
| 51 | +master_doc = '' |
63 | 52 |
|
64 | 53 | # The language for content autogenerated by Sphinx. Refer to documentation
|
65 | 54 | # for a list of supported languages.
|
|
73 | 62 | # This pattern also affects html_static_path and html_extra_path.
|
74 | 63 | exclude_patterns = []
|
75 | 64 |
|
76 |
| -# The name of the Pygments (syntax highlighting) style to use. |
77 |
| -pygments_style = 'sphinx' |
78 |
| - |
79 | 65 |
|
80 | 66 | # -- Options for HTML output -------------------------------------------------
|
81 | 67 |
|
|
106 | 92 | # html_sidebars = {}
|
107 | 93 |
|
108 | 94 |
|
109 |
| -# -- Options for HTMLHelp output --------------------------------------------- |
110 |
| - |
111 |
| -# Output file base name for HTML help builder. |
112 |
| -htmlhelp_basename = 'pypi-mobans-pkgdoc' |
113 |
| - |
114 |
| - |
115 |
| -# -- Options for LaTeX output ------------------------------------------------ |
116 |
| - |
117 |
| -latex_elements = { |
118 |
| - # The paper size ('letterpaper' or 'a4paper'). |
119 |
| - # |
120 |
| - # 'papersize': 'letterpaper', |
121 |
| - |
122 |
| - # The font size ('10pt', '11pt' or '12pt'). |
123 |
| - # |
124 |
| - # 'pointsize': '10pt', |
125 |
| - |
126 |
| - # Additional stuff for the LaTeX preamble. |
127 |
| - # |
128 |
| - # 'preamble': '', |
| 95 | +# -- Options for Epub output ------------------------------------------------- |
129 | 96 |
|
130 |
| - # Latex figure (float) alignment |
131 |
| - # |
132 |
| - # 'figure_align': 'htbp', |
133 |
| -} |
134 |
| - |
135 |
| -# Grouping the document tree into LaTeX files. List of tuples |
136 |
| -# (source start file, target name, title, |
137 |
| -# author, documentclass [howto, manual, or own class]). |
138 |
| -latex_documents = [ |
139 |
| - (master_doc, 'pypi-mobans-pkg.tex', u'pypi-mobans-pkg Documentation', |
140 |
| - u'Onni Software Ltd.', 'manual'), |
141 |
| -] |
142 |
| - |
143 |
| - |
144 |
| -# -- Options for manual page output ------------------------------------------ |
145 |
| - |
146 |
| -# One entry per manual page. List of tuples |
147 |
| -# (source start file, name, description, authors, manual section). |
148 |
| -man_pages = [ |
149 |
| - (master_doc, 'pypi-mobans-pkg', u'pypi-mobans-pkg Documentation', |
150 |
| - [author], 1) |
151 |
| -] |
| 97 | +# Bibliographic Dublin Core info. |
| 98 | +epub_title = project |
152 | 99 |
|
| 100 | +# The unique identifier of the text. This can be a ISBN number |
| 101 | +# or the project homepage. |
| 102 | +# |
| 103 | +# epub_identifier = '' |
153 | 104 |
|
154 |
| -# -- Options for Texinfo output ---------------------------------------------- |
| 105 | +# A unique identification for the text. |
| 106 | +# |
| 107 | +# epub_uid = '' |
155 | 108 |
|
156 |
| -# Grouping the document tree into Texinfo files. List of tuples |
157 |
| -# (source start file, target name, title, author, |
158 |
| -# dir menu entry, description, category) |
159 |
| -texinfo_documents = [ |
160 |
| - (master_doc, 'pypi-mobans-pkg', u'pypi-mobans-pkg Documentation', |
161 |
| - author, 'pypi-mobans-pkg', 'One line description of project.', |
162 |
| - 'Miscellaneous'), |
163 |
| -] |
| 109 | +# A list of files that should not be packed into the epub file. |
| 110 | +epub_exclude_files = ['search.html'] |
164 | 111 |
|
165 | 112 | # -- Extension configuration -------------------------------------------------
|
166 | 113 | # -- Options for intersphinx extension ---------------------------------------
|
167 | 114 |
|
168 | 115 | # Example configuration for intersphinx: refer to the Python standard library.
|
169 | 116 | intersphinx_mapping = {'https://docs.python.org/': None}
|
| 117 | + |
170 | 118 | # TODO: html_theme not configurable upstream
|
171 | 119 | html_theme = 'default'
|
172 | 120 |
|
173 | 121 | # TODO: DESCRIPTION not configurable upstream
|
174 | 122 | texinfo_documents = [
|
175 | 123 | ('index', 'pypi-mobans-pkg',
|
176 | 124 | 'pypi-mobans-pkg Documentation',
|
177 |
| - 'Onni Software Ltd.', 'pypi-mobans-pkg', |
| 125 | + 'Onni Software Ltd. and its contributors', 'pypi-mobans-pkg', |
178 | 126 | DESCRIPTION,
|
179 | 127 | 'Miscellaneous'),
|
180 | 128 | ]
|
|
0 commit comments