Skip to content

Commit 24c4ef1

Browse files
author
Pablo Martí
committed
first dump of the documentation (sphinx)
1 parent 4d42c01 commit 24c4ef1

25 files changed

+1836
-812
lines changed

‎doc/Makefile‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
PAPER =
8+
BUILDDIR = _build
9+
10+
# Internal variables.
11+
PAPEROPT_a4 = -D latex_paper_size=a4
12+
PAPEROPT_letter = -D latex_paper_size=letter
13+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
14+
15+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
16+
17+
help:
18+
@echo "Please use \`make <target>' where <target> is one of"
19+
@echo " html to make standalone HTML files"
20+
@echo " dirhtml to make HTML files named index.html in directories"
21+
@echo " singlehtml to make a single large HTML file"
22+
@echo " pickle to make pickle files"
23+
@echo " json to make JSON files"
24+
@echo " htmlhelp to make HTML files and a HTML help project"
25+
@echo " qthelp to make HTML files and a qthelp project"
26+
@echo " devhelp to make HTML files and a Devhelp project"
27+
@echo " epub to make an epub"
28+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
29+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
30+
@echo " text to make text files"
31+
@echo " man to make manual pages"
32+
@echo " changes to make an overview of all changed/added/deprecated items"
33+
@echo " linkcheck to check all external links for integrity"
34+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
35+
36+
clean:
37+
-rm -rf $(BUILDDIR)/*
38+
39+
html:
40+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
41+
@echo
42+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
43+
44+
dirhtml:
45+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
46+
@echo
47+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
48+
49+
singlehtml:
50+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
51+
@echo
52+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
53+
54+
pickle:
55+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
56+
@echo
57+
@echo "Build finished; now you can process the pickle files."
58+
59+
json:
60+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
61+
@echo
62+
@echo "Build finished; now you can process the JSON files."
63+
64+
htmlhelp:
65+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
66+
@echo
67+
@echo "Build finished; now you can run HTML Help Workshop with the" \
68+
".hhp project file in $(BUILDDIR)/htmlhelp."
69+
70+
qthelp:
71+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
72+
@echo
73+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
74+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
75+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/python-messaging.qhcp"
76+
@echo "To view the help file:"
77+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/python-messaging.qhc"
78+
79+
devhelp:
80+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
81+
@echo
82+
@echo "Build finished."
83+
@echo "To view the help file:"
84+
@echo "# mkdir -p $$HOME/.local/share/devhelp/python-messaging"
85+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/python-messaging"
86+
@echo "# devhelp"
87+
88+
epub:
89+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
90+
@echo
91+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
92+
93+
latex:
94+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
95+
@echo
96+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
97+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
98+
"(use \`make latexpdf' here to do that automatically)."
99+
100+
latexpdf:
101+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
102+
@echo "Running LaTeX files through pdflatex..."
103+
make -C $(BUILDDIR)/latex all-pdf
104+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
105+
106+
text:
107+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
108+
@echo
109+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
110+
111+
man:
112+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
113+
@echo
114+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
115+
116+
changes:
117+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
118+
@echo
119+
@echo "The overview file is in $(BUILDDIR)/changes."
120+
121+
linkcheck:
122+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
123+
@echo
124+
@echo "Link check complete; look for any errors in the above output " \
125+
"or in $(BUILDDIR)/linkcheck/output.txt."
126+
127+
doctest:
128+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
129+
@echo "Testing of doctests in the sources finished, look at the " \
130+
"results in $(BUILDDIR)/doctest/output.txt."

‎doc/conf.py‎

Lines changed: 194 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,194 @@
1+
# -*- coding: utf-8 -*-
2+
import sys, os
3+
4+
# If extensions (or modules to document with autodoc) are in another directory,
5+
# add these directories to sys.path here. If the directory is relative to the
6+
# documentation root, use os.path.abspath to make it absolute, like shown here.
7+
#sys.path.insert(0, os.path.abspath('.'))
8+
9+
# If your documentation needs a minimal Sphinx version, state it here.
10+
#needs_sphinx = '1.0'
11+
12+
# Add any Sphinx extension module names here, as strings. They can be extensions
13+
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
14+
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
15+
16+
# Add any paths that contain templates here, relative to this directory.
17+
templates_path = ['_templates']
18+
19+
# The suffix of source filenames.
20+
source_suffix = '.rst'
21+
22+
# The encoding of source files.
23+
#source_encoding = 'utf-8-sig'
24+
25+
# The master toctree document.
26+
master_doc = 'index'
27+
28+
# General information about the project.
29+
project = u'python-messaging'
30+
copyright = u'2010, Pablo Martí'
31+
32+
# The short X.Y version.
33+
version = '0.5.9'
34+
# The full version, including alpha/beta/rc tags.
35+
release = '0.5.9'
36+
37+
# The language for content autogenerated by Sphinx. Refer to documentation
38+
# for a list of supported languages.
39+
#language = None
40+
41+
today_fmt = '%B %d, %Y'
42+
43+
# List of patterns, relative to source directory, that match files and
44+
# directories to ignore when looking for source files.
45+
exclude_patterns = ['_build']
46+
47+
# The reST default role (used for this markup: `text`) to use for all documents.
48+
#default_role = None
49+
50+
# If true, '()' will be appended to :func: etc. cross-reference text.
51+
add_function_parentheses = True
52+
53+
# If true, the current module name will be prepended to all description
54+
# unit titles (such as .. function::).
55+
add_module_names = False
56+
57+
# If true, sectionauthor and moduleauthor directives will be shown in the
58+
# output. They are ignored by default.
59+
#show_authors = False
60+
61+
# The name of the Pygments (syntax highlighting) style to use.
62+
pygments_style = 'sphinx'
63+
64+
# A list of ignored prefixes for module index sorting.
65+
#modindex_common_prefix = []
66+
67+
68+
# -- Options for HTML output ---------------------------------------------------
69+
70+
# The theme to use for HTML and HTML Help pages. See the documentation for
71+
# a list of builtin themes.
72+
html_theme = 'default'
73+
74+
# Theme options are theme-specific and customize the look and feel of a theme
75+
# further. For a list of options available for each theme, see the
76+
# documentation.
77+
#html_theme_options = {}
78+
79+
# Add any paths that contain custom themes here, relative to this directory.
80+
#html_theme_path = []
81+
82+
# The name for this set of Sphinx documents. If None, it defaults to
83+
# "<project> v<release> documentation".
84+
#html_title = None
85+
86+
# A shorter title for the navigation bar. Default is the same as html_title.
87+
#html_short_title = None
88+
89+
# The name of an image file (relative to this directory) to place at the top
90+
# of the sidebar.
91+
#html_logo = None
92+
93+
# The name of an image file (within the static path) to use as favicon of the
94+
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
95+
# pixels large.
96+
#html_favicon = None
97+
98+
# Add any paths that contain custom static files (such as style sheets) here,
99+
# relative to this directory. They are copied after the builtin static files,
100+
# so a file named "default.css" will overwrite the builtin "default.css".
101+
html_static_path = ['_static']
102+
103+
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
104+
# using the given strftime format.
105+
#html_last_updated_fmt = '%b %d, %Y'
106+
107+
# If true, SmartyPants will be used to convert quotes and dashes to
108+
# typographically correct entities.
109+
html_use_smartypants = True
110+
111+
# Custom sidebar templates, maps document names to template names.
112+
#html_sidebars = {}
113+
114+
# Additional templates that should be rendered to pages, maps page names to
115+
# template names.
116+
#html_additional_pages = {}
117+
118+
# If false, no module index is generated.
119+
#html_domain_indices = True
120+
121+
# If false, no index is generated.
122+
#html_use_index = True
123+
124+
# If true, the index is split into individual pages for each letter.
125+
#html_split_index = False
126+
127+
# If true, links to the reST sources are added to the pages.
128+
html_show_sourcelink = True
129+
130+
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
131+
html_show_sphinx = True
132+
133+
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
134+
html_show_copyright = True
135+
136+
# If true, an OpenSearch description file will be output, and all pages will
137+
# contain a <link> tag referring to it. The value of this option must be the
138+
# base URL from which the finished HTML is served.
139+
#html_use_opensearch = ''
140+
141+
# This is the file name suffix for HTML files (e.g. ".xhtml").
142+
#html_file_suffix = None
143+
144+
# Output file base name for HTML help builder.
145+
htmlhelp_basename = 'python-messagingdoc'
146+
147+
148+
# -- Options for LaTeX output --------------------------------------------------
149+
150+
# The paper size ('letter' or 'a4').
151+
#latex_paper_size = 'letter'
152+
153+
# The font size ('10pt', '11pt' or '12pt').
154+
#latex_font_size = '10pt'
155+
156+
# Grouping the document tree into LaTeX files. List of tuples
157+
# (source start file, target name, title, author, documentclass [howto/manual]).
158+
latex_documents = [
159+
('index', 'python-messaging.tex', u'python-messaging Documentation',
160+
u'Pablo Martí', 'manual'),
161+
]
162+
163+
# The name of an image file (relative to this directory) to place at the top of
164+
# the title page.
165+
#latex_logo = None
166+
167+
# For "manual" documents, if this is true, then toplevel headings are parts,
168+
# not chapters.
169+
#latex_use_parts = False
170+
171+
# If true, show page references after internal links.
172+
#latex_show_pagerefs = False
173+
174+
# If true, show URL addresses after external links.
175+
#latex_show_urls = False
176+
177+
# Additional stuff for the LaTeX preamble.
178+
#latex_preamble = ''
179+
180+
# Documents to append as an appendix to all manuals.
181+
#latex_appendices = []
182+
183+
# If false, no module index is generated.
184+
#latex_domain_indices = True
185+
186+
187+
# -- Options for manual page output --------------------------------------------
188+
189+
# One entry per manual page. List of tuples
190+
# (source start file, name, description, authors, manual section).
191+
man_pages = [
192+
('index', 'python-messaging', u'python-messaging Documentation',
193+
[u'Pablo Martí'], 1)
194+
]

‎doc/glossary.rst‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
.. _glossary:
2+
3+
========
4+
Glossary
5+
========
6+
7+
.. glossary::
8+
:sorted:
9+
10+
MMS
11+
Multimedia Messaging Service, or MMS, is a standard way to send
12+
messages that include multimedia content to and from mobile
13+
phones. It extends the core SMS (Short Message Service) capability
14+
which only allowed exchange of text messages up to 160 characters
15+
in length.
16+
17+
SMS
18+
Short Message Service (SMS) is the text communication service
19+
component of phone, web or mobile communication systems, using
20+
standardized communications protocols that allow the exchange
21+
of short text messages (up to 160 characters) between fixed line
22+
or mobile phone devices.
23+
24+
WAP
25+
Wireless Application Protocol (WAP) is an open international standard
26+
for application-layer network communications in a wireless-communication
27+
environment. Most use of WAP involves accessing the mobile web from a
28+
mobile phone or from a PDA.

‎doc/index.rst‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
Welcome to python-messaging's documentation!
2+
============================================
3+
4+
Contents:
5+
6+
.. toctree::
7+
:maxdepth: 2
8+
9+
tutorial/sms
10+
tutorial/mms
11+
glossary
12+
13+
Indices and tables
14+
==================
15+
16+
* :ref:`genindex`
17+
* :ref:`modindex`
18+
* :ref:`glossary`
19+
* :ref:`search`
20+
21+
.. toctree::
22+
:hidden:
23+
:glob:
24+
25+
modules/*
26+
modules/sms/*
27+
modules/mms/*
28+

‎doc/modules/mms/iterator.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
:mod:`messaging.mms.iterator`
2+
=============================
3+
4+
.. automodule:: messaging.mms.iterator
5+
6+
Classes
7+
--------
8+
9+
.. autoclass:: PreviewIterator
10+
:members:

0 commit comments

Comments
 (0)