Merge lp:~tsimonq2/ubuntu-qa-website/sphinx into lp:ubuntu-qa-website
- sphinx
- Merge into drupal7-rewrite
Proposed by
Simon Quigley
Status: | Merged |
---|---|
Merged at revision: | 428 |
Proposed branch: | lp:~tsimonq2/ubuntu-qa-website/sphinx |
Merge into: | lp:ubuntu-qa-website |
Diff against target: |
567 lines (+543/-0) 5 files modified
python-library/Makefile (+216/-0) python-library/README (+15/-0) python-library/code.rst (+5/-0) python-library/conf.py (+285/-0) python-library/index.rst (+22/-0) |
To merge this branch: | bzr merge lp:~tsimonq2/ubuntu-qa-website/sphinx |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Nicholas Skaggs (community) | Needs Fixing | ||
Review via email: mp+287716@code.launchpad.net |
Commit message
Description of the change
To post a comment you must log in.
- 429. By Simon Quigley
-
Fixed trivial README instructions
- 430. By Simon Quigley
-
Removed empty directories
Preview Diff
[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1 | === added file 'python-library/Makefile' |
2 | --- python-library/Makefile 1970-01-01 00:00:00 +0000 |
3 | +++ python-library/Makefile 2016-03-01 22:25:12 +0000 |
4 | @@ -0,0 +1,216 @@ |
5 | +# Makefile for Sphinx documentation |
6 | +# |
7 | + |
8 | +# You can set these variables from the command line. |
9 | +SPHINXOPTS = |
10 | +SPHINXBUILD = sphinx-build |
11 | +PAPER = |
12 | +BUILDDIR = sphinxbuild |
13 | + |
14 | +# User-friendly check for sphinx-build |
15 | +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) |
16 | +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) |
17 | +endif |
18 | + |
19 | +# Internal variables. |
20 | +PAPEROPT_a4 = -D latex_paper_size=a4 |
21 | +PAPEROPT_letter = -D latex_paper_size=letter |
22 | +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . |
23 | +# the i18n builder cannot share the environment and doctrees with the others |
24 | +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . |
25 | + |
26 | +.PHONY: help |
27 | +help: |
28 | + @echo "Please use \`make <target>' where <target> is one of" |
29 | + @echo " html to make standalone HTML files" |
30 | + @echo " dirhtml to make HTML files named index.html in directories" |
31 | + @echo " singlehtml to make a single large HTML file" |
32 | + @echo " pickle to make pickle files" |
33 | + @echo " json to make JSON files" |
34 | + @echo " htmlhelp to make HTML files and a HTML help project" |
35 | + @echo " qthelp to make HTML files and a qthelp project" |
36 | + @echo " applehelp to make an Apple Help Book" |
37 | + @echo " devhelp to make HTML files and a Devhelp project" |
38 | + @echo " epub to make an epub" |
39 | + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" |
40 | + @echo " latexpdf to make LaTeX files and run them through pdflatex" |
41 | + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" |
42 | + @echo " text to make text files" |
43 | + @echo " man to make manual pages" |
44 | + @echo " texinfo to make Texinfo files" |
45 | + @echo " info to make Texinfo files and run them through makeinfo" |
46 | + @echo " gettext to make PO message catalogs" |
47 | + @echo " changes to make an overview of all changed/added/deprecated items" |
48 | + @echo " xml to make Docutils-native XML files" |
49 | + @echo " pseudoxml to make pseudoxml-XML files for display purposes" |
50 | + @echo " linkcheck to check all external links for integrity" |
51 | + @echo " doctest to run all doctests embedded in the documentation (if enabled)" |
52 | + @echo " coverage to run coverage check of the documentation (if enabled)" |
53 | + |
54 | +.PHONY: clean |
55 | +clean: |
56 | + rm -rf $(BUILDDIR)/* |
57 | + |
58 | +.PHONY: html |
59 | +html: |
60 | + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html |
61 | + @echo |
62 | + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." |
63 | + |
64 | +.PHONY: dirhtml |
65 | +dirhtml: |
66 | + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml |
67 | + @echo |
68 | + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." |
69 | + |
70 | +.PHONY: singlehtml |
71 | +singlehtml: |
72 | + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml |
73 | + @echo |
74 | + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." |
75 | + |
76 | +.PHONY: pickle |
77 | +pickle: |
78 | + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle |
79 | + @echo |
80 | + @echo "Build finished; now you can process the pickle files." |
81 | + |
82 | +.PHONY: json |
83 | +json: |
84 | + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json |
85 | + @echo |
86 | + @echo "Build finished; now you can process the JSON files." |
87 | + |
88 | +.PHONY: htmlhelp |
89 | +htmlhelp: |
90 | + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp |
91 | + @echo |
92 | + @echo "Build finished; now you can run HTML Help Workshop with the" \ |
93 | + ".hhp project file in $(BUILDDIR)/htmlhelp." |
94 | + |
95 | +.PHONY: qthelp |
96 | +qthelp: |
97 | + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp |
98 | + @echo |
99 | + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ |
100 | + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" |
101 | + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/UbuntuQATrackerAPI.qhcp" |
102 | + @echo "To view the help file:" |
103 | + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/UbuntuQATrackerAPI.qhc" |
104 | + |
105 | +.PHONY: applehelp |
106 | +applehelp: |
107 | + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp |
108 | + @echo |
109 | + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." |
110 | + @echo "N.B. You won't be able to view it unless you put it in" \ |
111 | + "~/Library/Documentation/Help or install it in your application" \ |
112 | + "bundle." |
113 | + |
114 | +.PHONY: devhelp |
115 | +devhelp: |
116 | + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp |
117 | + @echo |
118 | + @echo "Build finished." |
119 | + @echo "To view the help file:" |
120 | + @echo "# mkdir -p $$HOME/.local/share/devhelp/UbuntuQATrackerAPI" |
121 | + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/UbuntuQATrackerAPI" |
122 | + @echo "# devhelp" |
123 | + |
124 | +.PHONY: epub |
125 | +epub: |
126 | + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub |
127 | + @echo |
128 | + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." |
129 | + |
130 | +.PHONY: latex |
131 | +latex: |
132 | + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex |
133 | + @echo |
134 | + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." |
135 | + @echo "Run \`make' in that directory to run these through (pdf)latex" \ |
136 | + "(use \`make latexpdf' here to do that automatically)." |
137 | + |
138 | +.PHONY: latexpdf |
139 | +latexpdf: |
140 | + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex |
141 | + @echo "Running LaTeX files through pdflatex..." |
142 | + $(MAKE) -C $(BUILDDIR)/latex all-pdf |
143 | + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." |
144 | + |
145 | +.PHONY: latexpdfja |
146 | +latexpdfja: |
147 | + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex |
148 | + @echo "Running LaTeX files through platex and dvipdfmx..." |
149 | + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja |
150 | + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." |
151 | + |
152 | +.PHONY: text |
153 | +text: |
154 | + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text |
155 | + @echo |
156 | + @echo "Build finished. The text files are in $(BUILDDIR)/text." |
157 | + |
158 | +.PHONY: man |
159 | +man: |
160 | + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man |
161 | + @echo |
162 | + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." |
163 | + |
164 | +.PHONY: texinfo |
165 | +texinfo: |
166 | + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo |
167 | + @echo |
168 | + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." |
169 | + @echo "Run \`make' in that directory to run these through makeinfo" \ |
170 | + "(use \`make info' here to do that automatically)." |
171 | + |
172 | +.PHONY: info |
173 | +info: |
174 | + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo |
175 | + @echo "Running Texinfo files through makeinfo..." |
176 | + make -C $(BUILDDIR)/texinfo info |
177 | + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." |
178 | + |
179 | +.PHONY: gettext |
180 | +gettext: |
181 | + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale |
182 | + @echo |
183 | + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." |
184 | + |
185 | +.PHONY: changes |
186 | +changes: |
187 | + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes |
188 | + @echo |
189 | + @echo "The overview file is in $(BUILDDIR)/changes." |
190 | + |
191 | +.PHONY: linkcheck |
192 | +linkcheck: |
193 | + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck |
194 | + @echo |
195 | + @echo "Link check complete; look for any errors in the above output " \ |
196 | + "or in $(BUILDDIR)/linkcheck/output.txt." |
197 | + |
198 | +.PHONY: doctest |
199 | +doctest: |
200 | + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest |
201 | + @echo "Testing of doctests in the sources finished, look at the " \ |
202 | + "results in $(BUILDDIR)/doctest/output.txt." |
203 | + |
204 | +.PHONY: coverage |
205 | +coverage: |
206 | + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage |
207 | + @echo "Testing of coverage in the sources finished, look at the " \ |
208 | + "results in $(BUILDDIR)/coverage/python.txt." |
209 | + |
210 | +.PHONY: xml |
211 | +xml: |
212 | + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml |
213 | + @echo |
214 | + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." |
215 | + |
216 | +.PHONY: pseudoxml |
217 | +pseudoxml: |
218 | + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml |
219 | + @echo |
220 | + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." |
221 | |
222 | === added file 'python-library/README' |
223 | --- python-library/README 1970-01-01 00:00:00 +0000 |
224 | +++ python-library/README 2016-03-01 22:25:12 +0000 |
225 | @@ -0,0 +1,15 @@ |
226 | +Welcome to the Python library for the Ubuntu QA Tracker API! |
227 | + |
228 | +This uses Sphinx to generate documentation instead of doing it all by hand. |
229 | + |
230 | +The following files/directories are NOT Sphinx files: qatracker.py tests/ |
231 | + |
232 | +To make an HTML and text version (respectively) of the documentation, make sure you are in the same directory as this README and run the following in a terminal: |
233 | + |
234 | +make html |
235 | + |
236 | +make txt |
237 | + |
238 | +The built documentation should be in the sphinxbuild directory. If you built the HTML version, open sphinxbuild/html/index.html in your browser. |
239 | + |
240 | +If you have any questions, go to #ubuntu-quality on Freenode. |
241 | |
242 | === added file 'python-library/code.rst' |
243 | --- python-library/code.rst 1970-01-01 00:00:00 +0000 |
244 | +++ python-library/code.rst 2016-03-01 22:25:12 +0000 |
245 | @@ -0,0 +1,5 @@ |
246 | +Ubuntu QA Tracker API Documentation |
247 | +=================================== |
248 | + |
249 | +.. automodule:: qatracker |
250 | + :members: |
251 | |
252 | === added file 'python-library/conf.py' |
253 | --- python-library/conf.py 1970-01-01 00:00:00 +0000 |
254 | +++ python-library/conf.py 2016-03-01 22:25:12 +0000 |
255 | @@ -0,0 +1,285 @@ |
256 | +# -*- coding: utf-8 -*- |
257 | +# |
258 | +# Ubuntu QA Tracker API documentation build configuration file, created by |
259 | +# sphinx-quickstart on Tue Mar 1 15:58:09 2016. |
260 | +# |
261 | +# This file is execfile()d with the current directory set to its |
262 | +# containing dir. |
263 | +# |
264 | +# Note that not all possible configuration values are present in this |
265 | +# autogenerated file. |
266 | +# |
267 | +# All configuration values have a default; values that are commented out |
268 | +# serve to show the default. |
269 | + |
270 | +import sys |
271 | +import os |
272 | + |
273 | +# If extensions (or modules to document with autodoc) are in another directory, |
274 | +# add these directories to sys.path here. If the directory is relative to the |
275 | +# documentation root, use os.path.abspath to make it absolute, like shown here. |
276 | +sys.path.insert(0, os.path.abspath('.')) |
277 | + |
278 | +# -- General configuration ------------------------------------------------ |
279 | + |
280 | +# If your documentation needs a minimal Sphinx version, state it here. |
281 | +#needs_sphinx = '1.0' |
282 | + |
283 | +# Add any Sphinx extension module names here, as strings. They can be |
284 | +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
285 | +# ones. |
286 | +extensions = [ |
287 | + 'sphinx.ext.autodoc', |
288 | +] |
289 | + |
290 | +# Add any paths that contain templates here, relative to this directory. |
291 | +templates_path = ['sphinxtemplates'] |
292 | + |
293 | +# The suffix(es) of source filenames. |
294 | +# You can specify multiple suffix as a list of string: |
295 | +# source_suffix = ['.rst', '.md'] |
296 | +source_suffix = '.rst' |
297 | + |
298 | +# The encoding of source files. |
299 | +#source_encoding = 'utf-8-sig' |
300 | + |
301 | +# The master toctree document. |
302 | +master_doc = 'index' |
303 | + |
304 | +# General information about the project. |
305 | +project = u'Ubuntu QA Tracker API' |
306 | +copyright = u'2016, Ubuntu Contributors' |
307 | +author = u'Ubuntu Contributors' |
308 | + |
309 | +# The version info for the project you're documenting, acts as replacement for |
310 | +# |version| and |release|, also used in various other places throughout the |
311 | +# built documents. |
312 | +# |
313 | +# The short X.Y version. |
314 | +version = u'0.1' |
315 | +# The full version, including alpha/beta/rc tags. |
316 | +release = u'0.1' |
317 | + |
318 | +# The language for content autogenerated by Sphinx. Refer to documentation |
319 | +# for a list of supported languages. |
320 | +# |
321 | +# This is also used if you do content translation via gettext catalogs. |
322 | +# Usually you set "language" from the command line for these cases. |
323 | +language = None |
324 | + |
325 | +# There are two options for replacing |today|: either, you set today to some |
326 | +# non-false value, then it is used: |
327 | +#today = '' |
328 | +# Else, today_fmt is used as the format for a strftime call. |
329 | +#today_fmt = '%B %d, %Y' |
330 | + |
331 | +# List of patterns, relative to source directory, that match files and |
332 | +# directories to ignore when looking for source files. |
333 | +exclude_patterns = ['sphinxbuild'] |
334 | + |
335 | +# The reST default role (used for this markup: `text`) to use for all |
336 | +# documents. |
337 | +#default_role = None |
338 | + |
339 | +# If true, '()' will be appended to :func: etc. cross-reference text. |
340 | +#add_function_parentheses = True |
341 | + |
342 | +# If true, the current module name will be prepended to all description |
343 | +# unit titles (such as .. function::). |
344 | +#add_module_names = True |
345 | + |
346 | +# If true, sectionauthor and moduleauthor directives will be shown in the |
347 | +# output. They are ignored by default. |
348 | +#show_authors = False |
349 | + |
350 | +# The name of the Pygments (syntax highlighting) style to use. |
351 | +pygments_style = 'sphinx' |
352 | + |
353 | +# A list of ignored prefixes for module index sorting. |
354 | +#modindex_common_prefix = [] |
355 | + |
356 | +# If true, keep warnings as "system message" paragraphs in the built documents. |
357 | +#keep_warnings = False |
358 | + |
359 | +# If true, `todo` and `todoList` produce output, else they produce nothing. |
360 | +todo_include_todos = False |
361 | + |
362 | + |
363 | +# -- Options for HTML output ---------------------------------------------- |
364 | + |
365 | +# The theme to use for HTML and HTML Help pages. See the documentation for |
366 | +# a list of builtin themes. |
367 | +html_theme = 'alabaster' |
368 | + |
369 | +# Theme options are theme-specific and customize the look and feel of a theme |
370 | +# further. For a list of options available for each theme, see the |
371 | +# documentation. |
372 | +#html_theme_options = {} |
373 | + |
374 | +# Add any paths that contain custom themes here, relative to this directory. |
375 | +#html_theme_path = [] |
376 | + |
377 | +# The name for this set of Sphinx documents. If None, it defaults to |
378 | +# "<project> v<release> documentation". |
379 | +#html_title = None |
380 | + |
381 | +# A shorter title for the navigation bar. Default is the same as html_title. |
382 | +#html_short_title = None |
383 | + |
384 | +# The name of an image file (relative to this directory) to place at the top |
385 | +# of the sidebar. |
386 | +#html_logo = None |
387 | + |
388 | +# The name of an image file (within the static path) to use as favicon of the |
389 | +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
390 | +# pixels large. |
391 | +#html_favicon = None |
392 | + |
393 | +# Add any paths that contain custom static files (such as style sheets) here, |
394 | +# relative to this directory. They are copied after the builtin static files, |
395 | +# so a file named "default.css" will overwrite the builtin "default.css". |
396 | +html_static_path = ['sphinxstatic'] |
397 | + |
398 | +# Add any extra paths that contain custom files (such as robots.txt or |
399 | +# .htaccess) here, relative to this directory. These files are copied |
400 | +# directly to the root of the documentation. |
401 | +#html_extra_path = [] |
402 | + |
403 | +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
404 | +# using the given strftime format. |
405 | +#html_last_updated_fmt = '%b %d, %Y' |
406 | + |
407 | +# If true, SmartyPants will be used to convert quotes and dashes to |
408 | +# typographically correct entities. |
409 | +#html_use_smartypants = True |
410 | + |
411 | +# Custom sidebar templates, maps document names to template names. |
412 | +#html_sidebars = {} |
413 | + |
414 | +# Additional templates that should be rendered to pages, maps page names to |
415 | +# template names. |
416 | +#html_additional_pages = {} |
417 | + |
418 | +# If false, no module index is generated. |
419 | +#html_domain_indices = True |
420 | + |
421 | +# If false, no index is generated. |
422 | +#html_use_index = True |
423 | + |
424 | +# If true, the index is split into individual pages for each letter. |
425 | +#html_split_index = False |
426 | + |
427 | +# If true, links to the reST sources are added to the pages. |
428 | +#html_show_sourcelink = True |
429 | + |
430 | +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
431 | +#html_show_sphinx = True |
432 | + |
433 | +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
434 | +#html_show_copyright = True |
435 | + |
436 | +# If true, an OpenSearch description file will be output, and all pages will |
437 | +# contain a <link> tag referring to it. The value of this option must be the |
438 | +# base URL from which the finished HTML is served. |
439 | +#html_use_opensearch = '' |
440 | + |
441 | +# This is the file name suffix for HTML files (e.g. ".xhtml"). |
442 | +#html_file_suffix = None |
443 | + |
444 | +# Language to be used for generating the HTML full-text search index. |
445 | +# Sphinx supports the following languages: |
446 | +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' |
447 | +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' |
448 | +#html_search_language = 'en' |
449 | + |
450 | +# A dictionary with options for the search language support, empty by default. |
451 | +# Now only 'ja' uses this config value |
452 | +#html_search_options = {'type': 'default'} |
453 | + |
454 | +# The name of a javascript file (relative to the configuration directory) that |
455 | +# implements a search results scorer. If empty, the default will be used. |
456 | +#html_search_scorer = 'scorer.js' |
457 | + |
458 | +# Output file base name for HTML help builder. |
459 | +htmlhelp_basename = 'UbuntuQATrackerAPIdoc' |
460 | + |
461 | +# -- Options for LaTeX output --------------------------------------------- |
462 | + |
463 | +latex_elements = { |
464 | +# The paper size ('letterpaper' or 'a4paper'). |
465 | +#'papersize': 'letterpaper', |
466 | + |
467 | +# The font size ('10pt', '11pt' or '12pt'). |
468 | +#'pointsize': '10pt', |
469 | + |
470 | +# Additional stuff for the LaTeX preamble. |
471 | +#'preamble': '', |
472 | + |
473 | +# Latex figure (float) alignment |
474 | +#'figure_align': 'htbp', |
475 | +} |
476 | + |
477 | +# Grouping the document tree into LaTeX files. List of tuples |
478 | +# (source start file, target name, title, |
479 | +# author, documentclass [howto, manual, or own class]). |
480 | +latex_documents = [ |
481 | + (master_doc, 'UbuntuQATrackerAPI.tex', u'Ubuntu QA Tracker API Documentation', |
482 | + u'Ubuntu Contributors', 'manual'), |
483 | +] |
484 | + |
485 | +# The name of an image file (relative to this directory) to place at the top of |
486 | +# the title page. |
487 | +#latex_logo = None |
488 | + |
489 | +# For "manual" documents, if this is true, then toplevel headings are parts, |
490 | +# not chapters. |
491 | +#latex_use_parts = False |
492 | + |
493 | +# If true, show page references after internal links. |
494 | +#latex_show_pagerefs = False |
495 | + |
496 | +# If true, show URL addresses after external links. |
497 | +#latex_show_urls = False |
498 | + |
499 | +# Documents to append as an appendix to all manuals. |
500 | +#latex_appendices = [] |
501 | + |
502 | +# If false, no module index is generated. |
503 | +#latex_domain_indices = True |
504 | + |
505 | + |
506 | +# -- Options for manual page output --------------------------------------- |
507 | + |
508 | +# One entry per manual page. List of tuples |
509 | +# (source start file, name, description, authors, manual section). |
510 | +man_pages = [ |
511 | + (master_doc, 'ubuntuqatrackerapi', u'Ubuntu QA Tracker API Documentation', |
512 | + [author], 1) |
513 | +] |
514 | + |
515 | +# If true, show URL addresses after external links. |
516 | +#man_show_urls = False |
517 | + |
518 | + |
519 | +# -- Options for Texinfo output ------------------------------------------- |
520 | + |
521 | +# Grouping the document tree into Texinfo files. List of tuples |
522 | +# (source start file, target name, title, author, |
523 | +# dir menu entry, description, category) |
524 | +texinfo_documents = [ |
525 | + (master_doc, 'UbuntuQATrackerAPI', u'Ubuntu QA Tracker API Documentation', |
526 | + author, 'UbuntuQATrackerAPI', 'One line description of project.', |
527 | + 'Miscellaneous'), |
528 | +] |
529 | + |
530 | +# Documents to append as an appendix to all manuals. |
531 | +#texinfo_appendices = [] |
532 | + |
533 | +# If false, no module index is generated. |
534 | +#texinfo_domain_indices = True |
535 | + |
536 | +# How to display URL addresses: 'footnote', 'no', or 'inline'. |
537 | +#texinfo_show_urls = 'footnote' |
538 | + |
539 | +# If true, do not generate a @detailmenu in the "Top" node's menu. |
540 | +#texinfo_no_detailmenu = False |
541 | |
542 | === added file 'python-library/index.rst' |
543 | --- python-library/index.rst 1970-01-01 00:00:00 +0000 |
544 | +++ python-library/index.rst 2016-03-01 22:25:12 +0000 |
545 | @@ -0,0 +1,22 @@ |
546 | +.. Ubuntu QA Tracker API documentation master file, created by |
547 | + sphinx-quickstart on Tue Mar 1 15:58:09 2016. |
548 | + You can adapt this file completely to your liking, but it should at least |
549 | + contain the root `toctree` directive. |
550 | + |
551 | +Welcome to Ubuntu QA Tracker API's documentation! |
552 | +================================================= |
553 | + |
554 | +Contents: |
555 | + |
556 | +.. toctree:: |
557 | + :maxdepth: 2 |
558 | + |
559 | + code |
560 | + |
561 | +Indices and tables |
562 | +================== |
563 | + |
564 | +* :ref:`genindex` |
565 | +* :ref:`modindex` |
566 | +* :ref:`search` |
567 | + |
One minor tweak.