aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile225
-rw-r--r--docs/conf.py348
-rw-r--r--docs/contents.rst1
-rw-r--r--docs/index.rst17
4 files changed, 582 insertions, 9 deletions
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..fae2b97
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,225 @@
1# Makefile for Sphinx documentation
2#
3
4# You can set these variables from the command line.
5SPHINXOPTS =
6SPHINXBUILD = sphinx-build
7PAPER =
8BUILDDIR = _build
9
10# Internal variables.
11PAPEROPT_a4 = -D latex_paper_size=a4
12PAPEROPT_letter = -D latex_paper_size=letter
13ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
14# the i18n builder cannot share the environment and doctrees with the others
15I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
16
17.PHONY: help
18help:
19 @echo "Please use \`make <target>' where <target> is one of"
20 @echo " html to make standalone HTML files"
21 @echo " dirhtml to make HTML files named index.html in directories"
22 @echo " singlehtml to make a single large HTML file"
23 @echo " pickle to make pickle files"
24 @echo " json to make JSON files"
25 @echo " htmlhelp to make HTML files and a HTML help project"
26 @echo " qthelp to make HTML files and a qthelp project"
27 @echo " applehelp to make an Apple Help Book"
28 @echo " devhelp to make HTML files and a Devhelp project"
29 @echo " epub to make an epub"
30 @echo " epub3 to make an epub3"
31 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
32 @echo " latexpdf to make LaTeX files and run them through pdflatex"
33 @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
34 @echo " text to make text files"
35 @echo " man to make manual pages"
36 @echo " texinfo to make Texinfo files"
37 @echo " info to make Texinfo files and run them through makeinfo"
38 @echo " gettext to make PO message catalogs"
39 @echo " changes to make an overview of all changed/added/deprecated items"
40 @echo " xml to make Docutils-native XML files"
41 @echo " pseudoxml to make pseudoxml-XML files for display purposes"
42 @echo " linkcheck to check all external links for integrity"
43 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
44 @echo " coverage to run coverage check of the documentation (if enabled)"
45 @echo " dummy to check syntax errors of document sources"
46
47.PHONY: clean
48clean:
49 rm -rf $(BUILDDIR)/*
50
51.PHONY: html
52html:
53 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
54 @echo
55 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
56
57.PHONY: dirhtml
58dirhtml:
59 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
60 @echo
61 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
62
63.PHONY: singlehtml
64singlehtml:
65 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
66 @echo
67 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
68
69.PHONY: pickle
70pickle:
71 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
72 @echo
73 @echo "Build finished; now you can process the pickle files."
74
75.PHONY: json
76json:
77 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
78 @echo
79 @echo "Build finished; now you can process the JSON files."
80
81.PHONY: htmlhelp
82htmlhelp:
83 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
84 @echo
85 @echo "Build finished; now you can run HTML Help Workshop with the" \
86 ".hhp project file in $(BUILDDIR)/htmlhelp."
87
88.PHONY: qthelp
89qthelp:
90 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
91 @echo
92 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
93 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
94 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Mastodonpy.qhcp"
95 @echo "To view the help file:"
96 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Mastodonpy.qhc"
97
98.PHONY: applehelp
99applehelp:
100 $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
101 @echo
102 @echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
103 @echo "N.B. You won't be able to view it unless you put it in" \
104 "~/Library/Documentation/Help or install it in your application" \
105 "bundle."
106
107.PHONY: devhelp
108devhelp:
109 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
110 @echo
111 @echo "Build finished."
112 @echo "To view the help file:"
113 @echo "# mkdir -p $$HOME/.local/share/devhelp/Mastodonpy"
114 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Mastodonpy"
115 @echo "# devhelp"
116
117.PHONY: epub
118epub:
119 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
120 @echo
121 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
122
123.PHONY: epub3
124epub3:
125 $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
126 @echo
127 @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
128
129.PHONY: latex
130latex:
131 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
132 @echo
133 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
134 @echo "Run \`make' in that directory to run these through (pdf)latex" \
135 "(use \`make latexpdf' here to do that automatically)."
136
137.PHONY: latexpdf
138latexpdf:
139 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
140 @echo "Running LaTeX files through pdflatex..."
141 $(MAKE) -C $(BUILDDIR)/latex all-pdf
142 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
143
144.PHONY: latexpdfja
145latexpdfja:
146 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
147 @echo "Running LaTeX files through platex and dvipdfmx..."
148 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
149 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
150
151.PHONY: text
152text:
153 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
154 @echo
155 @echo "Build finished. The text files are in $(BUILDDIR)/text."
156
157.PHONY: man
158man:
159 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
160 @echo
161 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
162
163.PHONY: texinfo
164texinfo:
165 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
166 @echo
167 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
168 @echo "Run \`make' in that directory to run these through makeinfo" \
169 "(use \`make info' here to do that automatically)."
170
171.PHONY: info
172info:
173 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
174 @echo "Running Texinfo files through makeinfo..."
175 make -C $(BUILDDIR)/texinfo info
176 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
177
178.PHONY: gettext
179gettext:
180 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
181 @echo
182 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
183
184.PHONY: changes
185changes:
186 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
187 @echo
188 @echo "The overview file is in $(BUILDDIR)/changes."
189
190.PHONY: linkcheck
191linkcheck:
192 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
193 @echo
194 @echo "Link check complete; look for any errors in the above output " \
195 "or in $(BUILDDIR)/linkcheck/output.txt."
196
197.PHONY: doctest
198doctest:
199 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
200 @echo "Testing of doctests in the sources finished, look at the " \
201 "results in $(BUILDDIR)/doctest/output.txt."
202
203.PHONY: coverage
204coverage:
205 $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
206 @echo "Testing of coverage in the sources finished, look at the " \
207 "results in $(BUILDDIR)/coverage/python.txt."
208
209.PHONY: xml
210xml:
211 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
212 @echo
213 @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
214
215.PHONY: pseudoxml
216pseudoxml:
217 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
218 @echo
219 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
220
221.PHONY: dummy
222dummy:
223 $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
224 @echo
225 @echo "Build finished. Dummy builder generates no files."
diff --git a/docs/conf.py b/docs/conf.py
index 86f9db8..3ccb5ed 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,6 +1,346 @@
1import sys 1# -*- coding: utf-8 -*-
2import os 2#
3# Mastodon.py documentation build configuration file, created by
4# sphinx-quickstart on Thu Nov 24 01:25:38 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
15# If extensions (or modules to document with autodoc) are in another directory,
16# add these directories to sys.path here. If the directory is relative to the
17# documentation root, use os.path.abspath to make it absolute, like shown here.
18#
19# import os
20# import sys
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#
27# needs_sphinx = '1.0'
3 28
4extensions = ['sphinx.ext.autodoc'] 29import os
30import sys
5sys.path.insert(0, os.path.abspath('../')) 31sys.path.insert(0, os.path.abspath('../'))
6sys.path.insert(0, os.path.abspath('../../')) 32#print(sys.path)
33
34# Add any Sphinx extension module names here, as strings. They can be
35# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
36# ones.
37extensions = [
38 'sphinx.ext.autodoc',
39 'sphinx.ext.viewcode',
40]
41
42# Add any paths that contain templates here, relative to this directory.
43templates_path = ['_templates']
44
45# The suffix(es) of source filenames.
46# You can specify multiple suffix as a list of string:
47#
48# source_suffix = ['.rst', '.md']
49source_suffix = '.rst'
50
51# The encoding of source files.
52#
53# source_encoding = 'utf-8-sig'
54
55# The master toctree document.
56master_doc = 'index'
57
58# General information about the project.
59project = u'Mastodon.py'
60copyright = u'2016, Lorenz Diener'
61author = u'Lorenz Diener'
62
63# The version info for the project you're documenting, acts as replacement for
64# |version| and |release|, also used in various other places throughout the
65# built documents.
66#
67# The short X.Y version.
68version = u'0.9'
69# The full version, including alpha/beta/rc tags.
70release = u'0.9'
71
72# The language for content autogenerated by Sphinx. Refer to documentation
73# for a list of supported languages.
74#
75# This is also used if you do content translation via gettext catalogs.
76# Usually you set "language" from the command line for these cases.
77language = None
78
79# There are two options for replacing |today|: either, you set today to some
80# non-false value, then it is used:
81#
82# today = ''
83#
84# Else, today_fmt is used as the format for a strftime call.
85#
86# today_fmt = '%B %d, %Y'
87
88# List of patterns, relative to source directory, that match files and
89# directories to ignore when looking for source files.
90# This patterns also effect to html_static_path and html_extra_path
91exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
92
93# The reST default role (used for this markup: `text`) to use for all
94# documents.
95#
96# default_role = None
97
98# If true, '()' will be appended to :func: etc. cross-reference text.
99#
100# add_function_parentheses = True
101
102# If true, the current module name will be prepended to all description
103# unit titles (such as .. function::).
104#
105# add_module_names = True
106
107# If true, sectionauthor and moduleauthor directives will be shown in the
108# output. They are ignored by default.
109#
110# show_authors = False
111
112# The name of the Pygments (syntax highlighting) style to use.
113pygments_style = 'sphinx'
114
115# A list of ignored prefixes for module index sorting.
116# modindex_common_prefix = []
117
118# If true, keep warnings as "system message" paragraphs in the built documents.
119# keep_warnings = False
120
121# If true, `todo` and `todoList` produce output, else they produce nothing.
122todo_include_todos = False
123
124
125# -- Options for HTML output ----------------------------------------------
126
127# The theme to use for HTML and HTML Help pages. See the documentation for
128# a list of builtin themes.
129#
130html_theme = 'alabaster'
131
132# Theme options are theme-specific and customize the look and feel of a theme
133# further. For a list of options available for each theme, see the
134# documentation.
135#
136# html_theme_options = {}
137
138# Add any paths that contain custom themes here, relative to this directory.
139# html_theme_path = []
140
141# The name for this set of Sphinx documents.
142# "<project> v<release> documentation" by default.
143#
144# html_title = u'Mastodon.py v0.9'
145
146# A shorter title for the navigation bar. Default is the same as html_title.
147#
148# html_short_title = None
149
150# The name of an image file (relative to this directory) to place at the top
151# of the sidebar.
152#
153# html_logo = None
154
155# The name of an image file (relative to this directory) to use as a favicon of
156# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
157# pixels large.
158#
159# html_favicon = None
160
161# Add any paths that contain custom static files (such as style sheets) here,
162# relative to this directory. They are copied after the builtin static files,
163# so a file named "default.css" will overwrite the builtin "default.css".
164html_static_path = ['_static']
165
166# Add any extra paths that contain custom files (such as robots.txt or
167# .htaccess) here, relative to this directory. These files are copied
168# directly to the root of the documentation.
169#
170# html_extra_path = []
171
172# If not None, a 'Last updated on:' timestamp is inserted at every page
173# bottom, using the given strftime format.
174# The empty string is equivalent to '%b %d, %Y'.
175#
176# html_last_updated_fmt = None
177
178# If true, SmartyPants will be used to convert quotes and dashes to
179# typographically correct entities.
180#
181# html_use_smartypants = True
182
183# Custom sidebar templates, maps document names to template names.
184#
185# html_sidebars = {}
186
187# Additional templates that should be rendered to pages, maps page names to
188# template names.
189#
190# html_additional_pages = {}
191
192# If false, no module index is generated.
193#
194# html_domain_indices = True
195
196# If false, no index is generated.
197#
198# html_use_index = True
199
200# If true, the index is split into individual pages for each letter.
201#
202# html_split_index = False
203
204# If true, links to the reST sources are added to the pages.
205#
206# html_show_sourcelink = True
207
208# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
209#
210# html_show_sphinx = True
211
212# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
213#
214# html_show_copyright = True
215
216# If true, an OpenSearch description file will be output, and all pages will
217# contain a <link> tag referring to it. The value of this option must be the
218# base URL from which the finished HTML is served.
219#
220# html_use_opensearch = ''
221
222# This is the file name suffix for HTML files (e.g. ".xhtml").
223# html_file_suffix = None
224
225# Language to be used for generating the HTML full-text search index.
226# Sphinx supports the following languages:
227# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
228# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
229#
230# html_search_language = 'en'
231
232# A dictionary with options for the search language support, empty by default.
233# 'ja' uses this config value.
234# 'zh' user can custom change `jieba` dictionary path.
235#
236# html_search_options = {'type': 'default'}
237
238# The name of a javascript file (relative to the configuration directory) that
239# implements a search results scorer. If empty, the default will be used.
240#
241# html_search_scorer = 'scorer.js'
242
243# Output file base name for HTML help builder.
244htmlhelp_basename = 'Mastodonpydoc'
245
246# -- Options for LaTeX output ---------------------------------------------
247
248latex_elements = {
249 # The paper size ('letterpaper' or 'a4paper').
250 #
251 # 'papersize': 'letterpaper',
252
253 # The font size ('10pt', '11pt' or '12pt').
254 #
255 # 'pointsize': '10pt',
256
257 # Additional stuff for the LaTeX preamble.
258 #
259 # 'preamble': '',
260
261 # Latex figure (float) alignment
262 #
263 # 'figure_align': 'htbp',
264}
265
266# Grouping the document tree into LaTeX files. List of tuples
267# (source start file, target name, title,
268# author, documentclass [howto, manual, or own class]).
269latex_documents = [
270 (master_doc, 'Mastodonpy.tex', u'Mastodon.py Documentation',
271 u'Lorenz Diener', 'manual'),
272]
273
274# The name of an image file (relative to this directory) to place at the top of
275# the title page.
276#
277# latex_logo = None
278
279# For "manual" documents, if this is true, then toplevel headings are parts,
280# not chapters.
281#
282# latex_use_parts = False
283
284# If true, show page references after internal links.
285#
286# latex_show_pagerefs = False
287
288# If true, show URL addresses after external links.
289#
290# latex_show_urls = False
291
292# Documents to append as an appendix to all manuals.
293#
294# latex_appendices = []
295
296# It false, will not define \strong, \code, itleref, \crossref ... but only
297# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
298# packages.
299#
300# latex_keep_old_macro_names = True
301
302# If false, no module index is generated.
303#
304# latex_domain_indices = True
305
306
307# -- Options for manual page output ---------------------------------------
308
309# One entry per manual page. List of tuples
310# (source start file, name, description, authors, manual section).
311man_pages = [
312 (master_doc, 'mastodonpy', u'Mastodon.py Documentation',
313 [author], 1)
314]
315
316# If true, show URL addresses after external links.
317#
318# man_show_urls = False
319
320
321# -- Options for Texinfo output -------------------------------------------
322
323# Grouping the document tree into Texinfo files. List of tuples
324# (source start file, target name, title, author,
325# dir menu entry, description, category)
326texinfo_documents = [
327 (master_doc, 'Mastodonpy', u'Mastodon.py Documentation',
328 author, 'Mastodonpy', 'One line description of project.',
329 'Miscellaneous'),
330]
331
332# Documents to append as an appendix to all manuals.
333#
334# texinfo_appendices = []
335
336# If false, no module index is generated.
337#
338# texinfo_domain_indices = True
339
340# How to display URL addresses: 'footnote', 'no', or 'inline'.
341#
342# texinfo_show_urls = 'footnote'
343
344# If true, do not generate a @detailmenu in the "Top" node's menu.
345#
346# texinfo_no_detailmenu = False
diff --git a/docs/contents.rst b/docs/contents.rst
deleted file mode 100644
index fb1d2ad..0000000
--- a/docs/contents.rst
+++ /dev/null
@@ -1 +0,0 @@
1.. toctree::
diff --git a/docs/index.rst b/docs/index.rst
index 30d8f1e..1334538 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,7 +1,16 @@
1Mastodon.py 1.. Mastodon.py documentation master file, created by
2=========== 2 sphinx-quickstart on Thu Nov 24 01:25:38 2016.
3 You can adapt this file completely to your liking, but it should at least
4 contain the root `toctree` directive.
3 5
4Python wrapper for the Mastodon ( https://github.com/Gargron/mastodon/ ) API. 6Welcome to Mastodon.py's documentation!
7=======================================
5 8
9Contents:
10
11.. toctree::
12 :maxdepth: 2
13
14.. py:currentmodule:: mastodon
6.. autoclass:: Mastodon 15.. autoclass:: Mastodon
7 :members: \ No newline at end of file 16 :members:
Powered by cgit v1.2.3 (git 2.41.0)