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