Status: | Merged |
---|---|
Approved by: | Robert Bruce Park |
Approved revision: | 193 |
Merged at revision: | 216 |
Proposed branch: | lp:~robru/friends/docs |
Merge into: | lp:friends |
Diff against target: |
476 lines (+458/-0) 3 files modified
docs/Makefile (+153/-0) docs/conf.py (+258/-0) docs/index.rst (+47/-0) |
To merge this branch: | bzr merge lp:~robru/friends/docs |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
PS Jenkins bot (community) | continuous-integration | Approve | |
Ken VanDine | Needs Fixing | ||
Review via email: mp+159069@code.launchpad.net |
Commit message
Basic Sphinx boilerplate.
Description of the change
To post a comment you must log in.
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote : | # |
review:
Approve
(continuous-integration)
Revision history for this message
Ken VanDine (ken-vandine) wrote : | # |
The copyright should probably match the source, so Canonical Ltd.
I know this is the first pass, but maybe we should fix boilerplate like "One line description of project":
+texinfo_documents = [
+ ('index', 'friends', 'friends Documentation',
+ 'Robert Bruce Park, Ken VanDine, Barry Warsaw', 'friends', 'One line description of project.',
+ 'Miscellaneous'),
review:
Needs Fixing
lp:~robru/friends/docs
updated
- 192. By Robert Bruce Park
-
Fill out some boilerplate and copyright notices.
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote : | # |
PASSED: Continuous integration, rev:192
http://
Executed test runs:
SUCCESS: http://
Click here to trigger a rebuild:
http://
review:
Approve
(continuous-integration)
lp:~robru/friends/docs
updated
- 193. By Robert Bruce Park
-
Cleanup.
Preview Diff
[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1 | === added directory 'docs' | |||
2 | === added file 'docs/Makefile' | |||
3 | --- docs/Makefile 1970-01-01 00:00:00 +0000 | |||
4 | +++ docs/Makefile 2013-07-03 22:10:34 +0000 | |||
5 | @@ -0,0 +1,153 @@ | |||
6 | 1 | # Makefile for Sphinx documentation | ||
7 | 2 | # | ||
8 | 3 | |||
9 | 4 | # You can set these variables from the command line. | ||
10 | 5 | SPHINXOPTS = | ||
11 | 6 | SPHINXBUILD = sphinx-build | ||
12 | 7 | PAPER = | ||
13 | 8 | BUILDDIR = _build | ||
14 | 9 | |||
15 | 10 | # Internal variables. | ||
16 | 11 | PAPEROPT_a4 = -D latex_paper_size=a4 | ||
17 | 12 | PAPEROPT_letter = -D latex_paper_size=letter | ||
18 | 13 | ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | ||
19 | 14 | # the i18n builder cannot share the environment and doctrees with the others | ||
20 | 15 | I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | ||
21 | 16 | |||
22 | 17 | .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext | ||
23 | 18 | |||
24 | 19 | help: | ||
25 | 20 | @echo "Please use \`make <target>' where <target> is one of" | ||
26 | 21 | @echo " html to make standalone HTML files" | ||
27 | 22 | @echo " dirhtml to make HTML files named index.html in directories" | ||
28 | 23 | @echo " singlehtml to make a single large HTML file" | ||
29 | 24 | @echo " pickle to make pickle files" | ||
30 | 25 | @echo " json to make JSON files" | ||
31 | 26 | @echo " htmlhelp to make HTML files and a HTML help project" | ||
32 | 27 | @echo " qthelp to make HTML files and a qthelp project" | ||
33 | 28 | @echo " devhelp to make HTML files and a Devhelp project" | ||
34 | 29 | @echo " epub to make an epub" | ||
35 | 30 | @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" | ||
36 | 31 | @echo " latexpdf to make LaTeX files and run them through pdflatex" | ||
37 | 32 | @echo " text to make text files" | ||
38 | 33 | @echo " man to make manual pages" | ||
39 | 34 | @echo " texinfo to make Texinfo files" | ||
40 | 35 | @echo " info to make Texinfo files and run them through makeinfo" | ||
41 | 36 | @echo " gettext to make PO message catalogs" | ||
42 | 37 | @echo " changes to make an overview of all changed/added/deprecated items" | ||
43 | 38 | @echo " linkcheck to check all external links for integrity" | ||
44 | 39 | @echo " doctest to run all doctests embedded in the documentation (if enabled)" | ||
45 | 40 | |||
46 | 41 | clean: | ||
47 | 42 | -rm -rf $(BUILDDIR)/* | ||
48 | 43 | |||
49 | 44 | html: | ||
50 | 45 | $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html | ||
51 | 46 | @echo | ||
52 | 47 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." | ||
53 | 48 | |||
54 | 49 | dirhtml: | ||
55 | 50 | $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml | ||
56 | 51 | @echo | ||
57 | 52 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." | ||
58 | 53 | |||
59 | 54 | singlehtml: | ||
60 | 55 | $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml | ||
61 | 56 | @echo | ||
62 | 57 | @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." | ||
63 | 58 | |||
64 | 59 | pickle: | ||
65 | 60 | $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle | ||
66 | 61 | @echo | ||
67 | 62 | @echo "Build finished; now you can process the pickle files." | ||
68 | 63 | |||
69 | 64 | json: | ||
70 | 65 | $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json | ||
71 | 66 | @echo | ||
72 | 67 | @echo "Build finished; now you can process the JSON files." | ||
73 | 68 | |||
74 | 69 | htmlhelp: | ||
75 | 70 | $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp | ||
76 | 71 | @echo | ||
77 | 72 | @echo "Build finished; now you can run HTML Help Workshop with the" \ | ||
78 | 73 | ".hhp project file in $(BUILDDIR)/htmlhelp." | ||
79 | 74 | |||
80 | 75 | qthelp: | ||
81 | 76 | $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp | ||
82 | 77 | @echo | ||
83 | 78 | @echo "Build finished; now you can run "qcollectiongenerator" with the" \ | ||
84 | 79 | ".qhcp project file in $(BUILDDIR)/qthelp, like this:" | ||
85 | 80 | @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/friends.qhcp" | ||
86 | 81 | @echo "To view the help file:" | ||
87 | 82 | @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/friends.qhc" | ||
88 | 83 | |||
89 | 84 | devhelp: | ||
90 | 85 | $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp | ||
91 | 86 | @echo | ||
92 | 87 | @echo "Build finished." | ||
93 | 88 | @echo "To view the help file:" | ||
94 | 89 | @echo "# mkdir -p $$HOME/.local/share/devhelp/friends" | ||
95 | 90 | @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/friends" | ||
96 | 91 | @echo "# devhelp" | ||
97 | 92 | |||
98 | 93 | epub: | ||
99 | 94 | $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub | ||
100 | 95 | @echo | ||
101 | 96 | @echo "Build finished. The epub file is in $(BUILDDIR)/epub." | ||
102 | 97 | |||
103 | 98 | latex: | ||
104 | 99 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | ||
105 | 100 | @echo | ||
106 | 101 | @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." | ||
107 | 102 | @echo "Run \`make' in that directory to run these through (pdf)latex" \ | ||
108 | 103 | "(use \`make latexpdf' here to do that automatically)." | ||
109 | 104 | |||
110 | 105 | latexpdf: | ||
111 | 106 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | ||
112 | 107 | @echo "Running LaTeX files through pdflatex..." | ||
113 | 108 | $(MAKE) -C $(BUILDDIR)/latex all-pdf | ||
114 | 109 | @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." | ||
115 | 110 | |||
116 | 111 | text: | ||
117 | 112 | $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text | ||
118 | 113 | @echo | ||
119 | 114 | @echo "Build finished. The text files are in $(BUILDDIR)/text." | ||
120 | 115 | |||
121 | 116 | man: | ||
122 | 117 | $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man | ||
123 | 118 | @echo | ||
124 | 119 | @echo "Build finished. The manual pages are in $(BUILDDIR)/man." | ||
125 | 120 | |||
126 | 121 | texinfo: | ||
127 | 122 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo | ||
128 | 123 | @echo | ||
129 | 124 | @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." | ||
130 | 125 | @echo "Run \`make' in that directory to run these through makeinfo" \ | ||
131 | 126 | "(use \`make info' here to do that automatically)." | ||
132 | 127 | |||
133 | 128 | info: | ||
134 | 129 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo | ||
135 | 130 | @echo "Running Texinfo files through makeinfo..." | ||
136 | 131 | make -C $(BUILDDIR)/texinfo info | ||
137 | 132 | @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." | ||
138 | 133 | |||
139 | 134 | gettext: | ||
140 | 135 | $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale | ||
141 | 136 | @echo | ||
142 | 137 | @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." | ||
143 | 138 | |||
144 | 139 | changes: | ||
145 | 140 | $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes | ||
146 | 141 | @echo | ||
147 | 142 | @echo "The overview file is in $(BUILDDIR)/changes." | ||
148 | 143 | |||
149 | 144 | linkcheck: | ||
150 | 145 | $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck | ||
151 | 146 | @echo | ||
152 | 147 | @echo "Link check complete; look for any errors in the above output " \ | ||
153 | 148 | "or in $(BUILDDIR)/linkcheck/output.txt." | ||
154 | 149 | |||
155 | 150 | doctest: | ||
156 | 151 | $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest | ||
157 | 152 | @echo "Testing of doctests in the sources finished, look at the " \ | ||
158 | 153 | "results in $(BUILDDIR)/doctest/output.txt." | ||
159 | 0 | 154 | ||
160 | === added directory 'docs/_build' | |||
161 | === added directory 'docs/_static' | |||
162 | === added directory 'docs/_templates' | |||
163 | === added file 'docs/conf.py' | |||
164 | --- docs/conf.py 1970-01-01 00:00:00 +0000 | |||
165 | +++ docs/conf.py 2013-07-03 22:10:34 +0000 | |||
166 | @@ -0,0 +1,258 @@ | |||
167 | 1 | #!/usr/bin/env python3 | ||
168 | 2 | # friends -- send & receive messages from any social network | ||
169 | 3 | # Copyright (C) 2013 Canonical Ltd | ||
170 | 4 | # | ||
171 | 5 | # This program is free software: you can redistribute it and/or modify | ||
172 | 6 | # it under the terms of the GNU General Public License as published by | ||
173 | 7 | # the Free Software Foundation, version 3 of the License. | ||
174 | 8 | # | ||
175 | 9 | # This program is distributed in the hope that it will be useful, | ||
176 | 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
177 | 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
178 | 12 | # GNU General Public License for more details. | ||
179 | 13 | # | ||
180 | 14 | # You should have received a copy of the GNU General Public License | ||
181 | 15 | # along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
182 | 16 | |||
183 | 17 | |||
184 | 18 | # friends documentation build configuration file, created by | ||
185 | 19 | # sphinx-quickstart on Mon Apr 15 19:32:21 2013. | ||
186 | 20 | # | ||
187 | 21 | # This file is execfile()d with the current directory set to its containing dir. | ||
188 | 22 | # | ||
189 | 23 | # Note that not all possible configuration values are present in this | ||
190 | 24 | # autogenerated file. | ||
191 | 25 | # | ||
192 | 26 | # All configuration values have a default; values that are commented out | ||
193 | 27 | # serve to show the default. | ||
194 | 28 | |||
195 | 29 | import sys, os | ||
196 | 30 | |||
197 | 31 | # If extensions (or modules to document with autodoc) are in another directory, | ||
198 | 32 | # add these directories to sys.path here. If the directory is relative to the | ||
199 | 33 | # documentation root, use os.path.abspath to make it absolute, like shown here. | ||
200 | 34 | #sys.path.insert(0, os.path.abspath('.')) | ||
201 | 35 | |||
202 | 36 | # -- General configuration ----------------------------------------------------- | ||
203 | 37 | |||
204 | 38 | # If your documentation needs a minimal Sphinx version, state it here. | ||
205 | 39 | #needs_sphinx = '1.0' | ||
206 | 40 | |||
207 | 41 | # Add any Sphinx extension module names here, as strings. They can be extensions | ||
208 | 42 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | ||
209 | 43 | extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode'] | ||
210 | 44 | |||
211 | 45 | # Add any paths that contain templates here, relative to this directory. | ||
212 | 46 | templates_path = ['_templates'] | ||
213 | 47 | |||
214 | 48 | # The suffix of source filenames. | ||
215 | 49 | source_suffix = '.rst' | ||
216 | 50 | |||
217 | 51 | # The encoding of source files. | ||
218 | 52 | #source_encoding = 'utf-8-sig' | ||
219 | 53 | |||
220 | 54 | # The master toctree document. | ||
221 | 55 | master_doc = 'index' | ||
222 | 56 | |||
223 | 57 | # General information about the project. | ||
224 | 58 | project = 'friends' | ||
225 | 59 | copyright = '2013, Canonical Ltd' | ||
226 | 60 | |||
227 | 61 | # The version info for the project you're documenting, acts as replacement for | ||
228 | 62 | # |version| and |release|, also used in various other places throughout the | ||
229 | 63 | # built documents. | ||
230 | 64 | # | ||
231 | 65 | # The short X.Y version. | ||
232 | 66 | version = '0.2' | ||
233 | 67 | # The full version, including alpha/beta/rc tags. | ||
234 | 68 | release = '0.2' | ||
235 | 69 | |||
236 | 70 | # The language for content autogenerated by Sphinx. Refer to documentation | ||
237 | 71 | # for a list of supported languages. | ||
238 | 72 | #language = None | ||
239 | 73 | |||
240 | 74 | # There are two options for replacing |today|: either, you set today to some | ||
241 | 75 | # non-false value, then it is used: | ||
242 | 76 | #today = '' | ||
243 | 77 | # Else, today_fmt is used as the format for a strftime call. | ||
244 | 78 | #today_fmt = '%B %d, %Y' | ||
245 | 79 | |||
246 | 80 | # List of patterns, relative to source directory, that match files and | ||
247 | 81 | # directories to ignore when looking for source files. | ||
248 | 82 | exclude_patterns = ['_build'] | ||
249 | 83 | |||
250 | 84 | # The reST default role (used for this markup: `text`) to use for all documents. | ||
251 | 85 | #default_role = None | ||
252 | 86 | |||
253 | 87 | # If true, '()' will be appended to :func: etc. cross-reference text. | ||
254 | 88 | #add_function_parentheses = True | ||
255 | 89 | |||
256 | 90 | # If true, the current module name will be prepended to all description | ||
257 | 91 | # unit titles (such as .. function::). | ||
258 | 92 | #add_module_names = True | ||
259 | 93 | |||
260 | 94 | # If true, sectionauthor and moduleauthor directives will be shown in the | ||
261 | 95 | # output. They are ignored by default. | ||
262 | 96 | #show_authors = False | ||
263 | 97 | |||
264 | 98 | # The name of the Pygments (syntax highlighting) style to use. | ||
265 | 99 | pygments_style = 'sphinx' | ||
266 | 100 | |||
267 | 101 | # A list of ignored prefixes for module index sorting. | ||
268 | 102 | #modindex_common_prefix = [] | ||
269 | 103 | |||
270 | 104 | |||
271 | 105 | # -- Options for HTML output --------------------------------------------------- | ||
272 | 106 | |||
273 | 107 | # The theme to use for HTML and HTML Help pages. See the documentation for | ||
274 | 108 | # a list of builtin themes. | ||
275 | 109 | html_theme = 'default' | ||
276 | 110 | |||
277 | 111 | # Theme options are theme-specific and customize the look and feel of a theme | ||
278 | 112 | # further. For a list of options available for each theme, see the | ||
279 | 113 | # documentation. | ||
280 | 114 | #html_theme_options = {} | ||
281 | 115 | |||
282 | 116 | # Add any paths that contain custom themes here, relative to this directory. | ||
283 | 117 | #html_theme_path = [] | ||
284 | 118 | |||
285 | 119 | # The name for this set of Sphinx documents. If None, it defaults to | ||
286 | 120 | # "<project> v<release> documentation". | ||
287 | 121 | #html_title = None | ||
288 | 122 | |||
289 | 123 | # A shorter title for the navigation bar. Default is the same as html_title. | ||
290 | 124 | #html_short_title = None | ||
291 | 125 | |||
292 | 126 | # The name of an image file (relative to this directory) to place at the top | ||
293 | 127 | # of the sidebar. | ||
294 | 128 | #html_logo = None | ||
295 | 129 | |||
296 | 130 | # The name of an image file (within the static path) to use as favicon of the | ||
297 | 131 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 | ||
298 | 132 | # pixels large. | ||
299 | 133 | #html_favicon = None | ||
300 | 134 | |||
301 | 135 | # Add any paths that contain custom static files (such as style sheets) here, | ||
302 | 136 | # relative to this directory. They are copied after the builtin static files, | ||
303 | 137 | # so a file named "default.css" will overwrite the builtin "default.css". | ||
304 | 138 | html_static_path = ['_static'] | ||
305 | 139 | |||
306 | 140 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | ||
307 | 141 | # using the given strftime format. | ||
308 | 142 | #html_last_updated_fmt = '%b %d, %Y' | ||
309 | 143 | |||
310 | 144 | # If true, SmartyPants will be used to convert quotes and dashes to | ||
311 | 145 | # typographically correct entities. | ||
312 | 146 | #html_use_smartypants = True | ||
313 | 147 | |||
314 | 148 | # Custom sidebar templates, maps document names to template names. | ||
315 | 149 | #html_sidebars = {} | ||
316 | 150 | |||
317 | 151 | # Additional templates that should be rendered to pages, maps page names to | ||
318 | 152 | # template names. | ||
319 | 153 | #html_additional_pages = {} | ||
320 | 154 | |||
321 | 155 | # If false, no module index is generated. | ||
322 | 156 | #html_domain_indices = True | ||
323 | 157 | |||
324 | 158 | # If false, no index is generated. | ||
325 | 159 | #html_use_index = True | ||
326 | 160 | |||
327 | 161 | # If true, the index is split into individual pages for each letter. | ||
328 | 162 | #html_split_index = False | ||
329 | 163 | |||
330 | 164 | # If true, links to the reST sources are added to the pages. | ||
331 | 165 | #html_show_sourcelink = True | ||
332 | 166 | |||
333 | 167 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. | ||
334 | 168 | #html_show_sphinx = True | ||
335 | 169 | |||
336 | 170 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. | ||
337 | 171 | #html_show_copyright = True | ||
338 | 172 | |||
339 | 173 | # If true, an OpenSearch description file will be output, and all pages will | ||
340 | 174 | # contain a <link> tag referring to it. The value of this option must be the | ||
341 | 175 | # base URL from which the finished HTML is served. | ||
342 | 176 | #html_use_opensearch = '' | ||
343 | 177 | |||
344 | 178 | # This is the file name suffix for HTML files (e.g. ".xhtml"). | ||
345 | 179 | #html_file_suffix = None | ||
346 | 180 | |||
347 | 181 | # Output file base name for HTML help builder. | ||
348 | 182 | htmlhelp_basename = 'friendsdoc' | ||
349 | 183 | |||
350 | 184 | |||
351 | 185 | # -- Options for LaTeX output -------------------------------------------------- | ||
352 | 186 | |||
353 | 187 | latex_elements = { | ||
354 | 188 | # The paper size ('letterpaper' or 'a4paper'). | ||
355 | 189 | #'papersize': 'letterpaper', | ||
356 | 190 | |||
357 | 191 | # The font size ('10pt', '11pt' or '12pt'). | ||
358 | 192 | #'pointsize': '10pt', | ||
359 | 193 | |||
360 | 194 | # Additional stuff for the LaTeX preamble. | ||
361 | 195 | #'preamble': '', | ||
362 | 196 | } | ||
363 | 197 | |||
364 | 198 | # Grouping the document tree into LaTeX files. List of tuples | ||
365 | 199 | # (source start file, target name, title, author, documentclass [howto/manual]). | ||
366 | 200 | latex_documents = [ | ||
367 | 201 | ('index', 'friends.tex', 'Friends Documentation', | ||
368 | 202 | 'Robert Bruce Park, Ken VanDine, Barry Warsaw', 'manual'), | ||
369 | 203 | ] | ||
370 | 204 | |||
371 | 205 | # The name of an image file (relative to this directory) to place at the top of | ||
372 | 206 | # the title page. | ||
373 | 207 | #latex_logo = None | ||
374 | 208 | |||
375 | 209 | # For "manual" documents, if this is true, then toplevel headings are parts, | ||
376 | 210 | # not chapters. | ||
377 | 211 | #latex_use_parts = False | ||
378 | 212 | |||
379 | 213 | # If true, show page references after internal links. | ||
380 | 214 | #latex_show_pagerefs = False | ||
381 | 215 | |||
382 | 216 | # If true, show URL addresses after external links. | ||
383 | 217 | #latex_show_urls = False | ||
384 | 218 | |||
385 | 219 | # Documents to append as an appendix to all manuals. | ||
386 | 220 | #latex_appendices = [] | ||
387 | 221 | |||
388 | 222 | # If false, no module index is generated. | ||
389 | 223 | #latex_domain_indices = True | ||
390 | 224 | |||
391 | 225 | |||
392 | 226 | # -- Options for manual page output -------------------------------------------- | ||
393 | 227 | |||
394 | 228 | # One entry per manual page. List of tuples | ||
395 | 229 | # (source start file, name, description, authors, manual section). | ||
396 | 230 | man_pages = [ | ||
397 | 231 | ('index', 'friends', 'Friends Documentation', | ||
398 | 232 | ['Robert Bruce Park, Ken VanDine, Barry Warsaw'], 1) | ||
399 | 233 | ] | ||
400 | 234 | |||
401 | 235 | # If true, show URL addresses after external links. | ||
402 | 236 | #man_show_urls = False | ||
403 | 237 | |||
404 | 238 | |||
405 | 239 | # -- Options for Texinfo output ------------------------------------------------ | ||
406 | 240 | |||
407 | 241 | # Grouping the document tree into Texinfo files. List of tuples | ||
408 | 242 | # (source start file, target name, title, author, | ||
409 | 243 | # dir menu entry, description, category) | ||
410 | 244 | texinfo_documents = [ | ||
411 | 245 | ('index', 'friends', 'Friends Documentation', | ||
412 | 246 | 'Robert Bruce Park, Ken VanDine, Barry Warsaw', 'friends', | ||
413 | 247 | 'Social networking integration for linux systems.', | ||
414 | 248 | 'Miscellaneous'), | ||
415 | 249 | ] | ||
416 | 250 | |||
417 | 251 | # Documents to append as an appendix to all manuals. | ||
418 | 252 | #texinfo_appendices = [] | ||
419 | 253 | |||
420 | 254 | # If false, no module index is generated. | ||
421 | 255 | #texinfo_domain_indices = True | ||
422 | 256 | |||
423 | 257 | # How to display URL addresses: 'footnote', 'no', or 'inline'. | ||
424 | 258 | #texinfo_show_urls = 'footnote' | ||
425 | 0 | 259 | ||
426 | === added file 'docs/index.rst' | |||
427 | --- docs/index.rst 1970-01-01 00:00:00 +0000 | |||
428 | +++ docs/index.rst 2013-07-03 22:10:34 +0000 | |||
429 | @@ -0,0 +1,47 @@ | |||
430 | 1 | .. friends documentation master file, created by | ||
431 | 2 | sphinx-quickstart on Mon Apr 15 19:32:21 2013. | ||
432 | 3 | friends -- send & receive messages from any social network | ||
433 | 4 | Copyright (C) 2013 Canonical Ltd | ||
434 | 5 | |||
435 | 6 | This program is free software: you can redistribute it and/or modify | ||
436 | 7 | it under the terms of the GNU General Public License as published by | ||
437 | 8 | the Free Software Foundation, version 3 of the License. | ||
438 | 9 | |||
439 | 10 | This program is distributed in the hope that it will be useful, | ||
440 | 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
441 | 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
442 | 13 | GNU General Public License for more details. | ||
443 | 14 | |||
444 | 15 | You should have received a copy of the GNU General Public License | ||
445 | 16 | along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
446 | 17 | |||
447 | 18 | The Superclass of all Protocols | ||
448 | 19 | =============================== | ||
449 | 20 | |||
450 | 21 | .. automodule:: friends.utils.base | ||
451 | 22 | :members: | ||
452 | 23 | :special-members: | ||
453 | 24 | :private-members: | ||
454 | 25 | |||
455 | 26 | Dispatcher | ||
456 | 27 | ========== | ||
457 | 28 | |||
458 | 29 | .. automodule:: friends.service.dispatcher | ||
459 | 30 | :members: | ||
460 | 31 | :special-members: | ||
461 | 32 | :private-members: | ||
462 | 33 | |||
463 | 34 | libsoup wrappers | ||
464 | 35 | ================ | ||
465 | 36 | |||
466 | 37 | .. automodule:: friends.utils.http | ||
467 | 38 | :members: | ||
468 | 39 | :special-members: | ||
469 | 40 | :private-members: | ||
470 | 41 | |||
471 | 42 | Indices and tables | ||
472 | 43 | ================== | ||
473 | 44 | |||
474 | 45 | * :ref:`genindex` | ||
475 | 46 | * :ref:`modindex` | ||
476 | 47 | * :ref:`search` |
PASSED: Continuous integration, rev:191 jenkins. qa.ubuntu. com/job/ friends- ci/33/ jenkins. qa.ubuntu. com/job/ friends- raring- amd64-ci/ 33
http://
Executed test runs:
SUCCESS: http://
Click here to trigger a rebuild: s-jenkins: 8080/job/ friends- ci/33/rebuild
http://