summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFausto Marzi <fausto.marzi@ericsson.com>2016-02-05 15:17:01 +0000
committerFausto Marzi <fausto.marzi@ericsson.com>2016-02-09 15:02:05 +0000
commit4c5ee4ca57918f705b3d06ad54ff8731642f58df (patch)
treeada2412e0b0db4a70ab00a54887b37609fe33493
parentda9cbb1968436cd038c371d00df47e789b67efec (diff)
Add Sphinx doc build
Bump setup.cfg version to 2.0.0 (mitaka) Change-Id: I3c2d63262a87a7d84bd95640de0140332e3e34ae Closes-Bug: #1542061
Notes
Notes (review): Code-Review+2: Eldar Nugaev <eldar.nugaev@hp.com> Workflow+1: Memo Garcia <guillermo.ramirez-garcia@hp.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Tue, 09 Feb 2016 16:11:30 +0000 Reviewed-on: https://review.openstack.org/276777 Project: openstack/freezer-web-ui Branch: refs/heads/master
-rw-r--r--.gitignore3
-rw-r--r--doc/.gitignore2
-rw-r--r--doc/source/conf.py260
-rw-r--r--doc/source/index.rst22
-rw-r--r--setup.cfg11
-rw-r--r--tox.ini5
6 files changed, 300 insertions, 3 deletions
diff --git a/.gitignore b/.gitignore
index c5b4ea3..af69605 100644
--- a/.gitignore
+++ b/.gitignore
@@ -17,6 +17,9 @@ coverage.xml
17*.log 17*.log
18.testrepository 18.testrepository
19subunit.log 19subunit.log
20.cache
21AUTHORS
22ChangeLog
20 23
21# Django files that get created during the test runs 24# Django files that get created during the test runs
22.secret_key_store 25.secret_key_store
diff --git a/doc/.gitignore b/doc/.gitignore
new file mode 100644
index 0000000..8e0be80
--- /dev/null
+++ b/doc/.gitignore
@@ -0,0 +1,2 @@
1build/
2source/ref/
diff --git a/doc/source/conf.py b/doc/source/conf.py
new file mode 100644
index 0000000..f1849dd
--- /dev/null
+++ b/doc/source/conf.py
@@ -0,0 +1,260 @@
1# -*- coding: utf-8 -*-
2#
3# freezer-web-ui documentation build configuration file, created by
4# sphinx-quickstart on Fri Feb 5 15:10:15 2016.
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
15import sys
16import os
17
18# If extensions (or modules to document with autodoc) are in another directory,
19# add these directories to sys.path here. If the directory is relative to the
20# documentation root, use os.path.abspath to make it absolute, like shown here.
21#sys.path.insert(0, os.path.abspath('.'))
22
23# -- General configuration ------------------------------------------------
24
25# If your documentation needs a minimal Sphinx version, state it here.
26#needs_sphinx = '1.0'
27
28# Add any Sphinx extension module names here, as strings. They can be
29# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
30# ones.
31extensions = [
32 'sphinx.ext.autodoc',
33]
34
35# Add any paths that contain templates here, relative to this directory.
36templates_path = ['_templates']
37
38# The suffix of source filenames.
39source_suffix = '.rst'
40
41# The encoding of source files.
42#source_encoding = 'utf-8-sig'
43
44# The master toctree document.
45master_doc = 'index'
46
47# General information about the project.
48project = u'freezer-web-ui'
49copyright = u'2016, OpenStack'
50
51# The version info for the project you're documenting, acts as replacement for
52# |version| and |release|, also used in various other places throughout the
53# built documents.
54#
55# The short X.Y version.
56version = '1.2'
57# The full version, including alpha/beta/rc tags.
58release = '1.2.0'
59
60# The language for content autogenerated by Sphinx. Refer to documentation
61# for a list of supported languages.
62#language = None
63
64# There are two options for replacing |today|: either, you set today to some
65# non-false value, then it is used:
66#today = ''
67# Else, today_fmt is used as the format for a strftime call.
68#today_fmt = '%B %d, %Y'
69
70# List of patterns, relative to source directory, that match files and
71# directories to ignore when looking for source files.
72exclude_patterns = []
73
74# The reST default role (used for this markup: `text`) to use for all
75# documents.
76#default_role = None
77
78# If true, '()' will be appended to :func: etc. cross-reference text.
79#add_function_parentheses = True
80
81# If true, the current module name will be prepended to all description
82# unit titles (such as .. function::).
83#add_module_names = True
84
85# If true, sectionauthor and moduleauthor directives will be shown in the
86# output. They are ignored by default.
87#show_authors = False
88
89# The name of the Pygments (syntax highlighting) style to use.
90pygments_style = 'sphinx'
91
92# A list of ignored prefixes for module index sorting.
93#modindex_common_prefix = []
94
95# If true, keep warnings as "system message" paragraphs in the built documents.
96#keep_warnings = False
97
98
99# -- Options for HTML output ----------------------------------------------
100
101# The theme to use for HTML and HTML Help pages. See the documentation for
102# a list of builtin themes.
103html_theme = 'default'
104
105# Theme options are theme-specific and customize the look and feel of a theme
106# further. For a list of options available for each theme, see the
107# documentation.
108#html_theme_options = {}
109
110# Add any paths that contain custom themes here, relative to this directory.
111#html_theme_path = []
112
113# The name for this set of Sphinx documents. If None, it defaults to
114# "<project> v<release> documentation".
115#html_title = None
116
117# A shorter title for the navigation bar. Default is the same as html_title.
118#html_short_title = None
119
120# The name of an image file (relative to this directory) to place at the top
121# of the sidebar.
122#html_logo = None
123
124# The name of an image file (within the static path) to use as favicon of the
125# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
126# pixels large.
127#html_favicon = None
128
129# Add any paths that contain custom static files (such as style sheets) here,
130# relative to this directory. They are copied after the builtin static files,
131# so a file named "default.css" will overwrite the builtin "default.css".
132html_static_path = ['_static']
133
134# Add any extra paths that contain custom files (such as robots.txt or
135# .htaccess) here, relative to this directory. These files are copied
136# directly to the root of the documentation.
137#html_extra_path = []
138
139# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
140# using the given strftime format.
141#html_last_updated_fmt = '%b %d, %Y'
142
143# If true, SmartyPants will be used to convert quotes and dashes to
144# typographically correct entities.
145#html_use_smartypants = True
146
147# Custom sidebar templates, maps document names to template names.
148#html_sidebars = {}
149
150# Additional templates that should be rendered to pages, maps page names to
151# template names.
152#html_additional_pages = {}
153
154# If false, no module index is generated.
155#html_domain_indices = True
156
157# If false, no index is generated.
158#html_use_index = True
159
160# If true, the index is split into individual pages for each letter.
161#html_split_index = False
162
163# If true, links to the reST sources are added to the pages.
164#html_show_sourcelink = True
165
166# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
167#html_show_sphinx = True
168
169# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
170#html_show_copyright = True
171
172# If true, an OpenSearch description file will be output, and all pages will
173# contain a <link> tag referring to it. The value of this option must be the
174# base URL from which the finished HTML is served.
175#html_use_opensearch = ''
176
177# This is the file name suffix for HTML files (e.g. ".xhtml").
178#html_file_suffix = None
179
180# Output file base name for HTML help builder.
181htmlhelp_basename = 'freezer-web-uidoc'
182
183
184# -- Options for LaTeX output ---------------------------------------------
185
186latex_elements = {
187# The paper size ('letterpaper' or 'a4paper').
188#'papersize': 'letterpaper',
189
190# The font size ('10pt', '11pt' or '12pt').
191#'pointsize': '10pt',
192
193# Additional stuff for the LaTeX preamble.
194#'preamble': '',
195}
196
197# Grouping the document tree into LaTeX files. List of tuples
198# (source start file, target name, title,
199# author, documentclass [howto, manual, or own class]).
200latex_documents = [
201 ('index', 'freezer-web-ui.tex', u'freezer-web-ui Documentation',
202 u'OpenStack', 'manual'),
203]
204
205# The name of an image file (relative to this directory) to place at the top of
206# the title page.
207#latex_logo = None
208
209# For "manual" documents, if this is true, then toplevel headings are parts,
210# not chapters.
211#latex_use_parts = False
212
213# If true, show page references after internal links.
214#latex_show_pagerefs = False
215
216# If true, show URL addresses after external links.
217#latex_show_urls = False
218
219# Documents to append as an appendix to all manuals.
220#latex_appendices = []
221
222# If false, no module index is generated.
223#latex_domain_indices = True
224
225
226# -- Options for manual page output ---------------------------------------
227
228# One entry per manual page. List of tuples
229# (source start file, name, description, authors, manual section).
230man_pages = [
231 ('index', 'freezer-web-ui', u'freezer-web-ui Documentation',
232 [u'OpenStack'], 1)
233]
234
235# If true, show URL addresses after external links.
236#man_show_urls = False
237
238
239# -- Options for Texinfo output -------------------------------------------
240
241# Grouping the document tree into Texinfo files. List of tuples
242# (source start file, target name, title, author,
243# dir menu entry, description, category)
244texinfo_documents = [
245 ('index', 'freezer-web-ui', u'freezer-web-ui Documentation',
246 u'OpenStack', 'freezer-web-ui', 'One line description of project.',
247 'Miscellaneous'),
248]
249
250# Documents to append as an appendix to all manuals.
251#texinfo_appendices = []
252
253# If false, no module index is generated.
254#texinfo_domain_indices = True
255
256# How to display URL addresses: 'footnote', 'no', or 'inline'.
257#texinfo_show_urls = 'footnote'
258
259# If true, do not generate a @detailmenu in the "Top" node's menu.
260#texinfo_no_detailmenu = False
diff --git a/doc/source/index.rst b/doc/source/index.rst
new file mode 100644
index 0000000..b777852
--- /dev/null
+++ b/doc/source/index.rst
@@ -0,0 +1,22 @@
1.. freezer-web-ui documentation master file, created by
2 sphinx-quickstart on Fri Feb 5 15:10:15 2016.
3 You can adapt this file completely to your liking, but it should at least
4 contain the root `toctree` directive.
5
6Welcome to freezer-web-ui's documentation!
7==========================================
8
9Contents:
10
11.. toctree::
12 :maxdepth: 2
13
14
15
16Indices and tables
17==================
18
19* :ref:`genindex`
20* :ref:`modindex`
21* :ref:`search`
22
diff --git a/setup.cfg b/setup.cfg
index 5ed5387..67e0989 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,8 +1,8 @@
1[metadata] 1[metadata]
2name = freezer-web-ui 2name = freezer-web-ui
3version = 1.2.0 3version = 2.0.0
4author = Fabrizio Fresco, Fausto Marzi, Jonas Pfannschmidt, Guillermo Ramirez Garcia 4author = Freezer Team
5author-email = memo@hpe.com 5author-email = openstack-dev@lists.openstack.org
6summary = Freezer - Backup as a Service User Interface 6summary = Freezer - Backup as a Service User Interface
7description-file = README.rst 7description-file = README.rst
8home-page = https://github.com/openstack/freezer-web-ui 8home-page = https://github.com/openstack/freezer-web-ui
@@ -30,5 +30,10 @@ keywords =
30packages = 30packages =
31 disaster_recovery 31 disaster_recovery
32 32
33[build_sphinx]
34source-dir = doc/source
35build-dir = doc/build
36all_files = 1
37
33[bdist_wheel] 38[bdist_wheel]
34universal = 1 39universal = 1
diff --git a/tox.ini b/tox.ini
index 13e3d87..5130477 100644
--- a/tox.ini
+++ b/tox.ini
@@ -28,3 +28,8 @@ exclude=.venv,.tox,dist,doc,test,*egg,tests,runtests.py
28 28
29[testenv:pylint] 29[testenv:pylint]
30commands = pylint --rcfile .pylintrc disaster_recovery 30commands = pylint --rcfile .pylintrc disaster_recovery
31
32[testenv:docs]
33commands =
34 python setup.py build_sphinx
35