Browse Source

Initial documentation setup

Bradlee Speice 6 years ago
parent
commit
18a9bde325
7 changed files with 5213 additions and 0 deletions
  1. 1
    0
      .gitignore
  2. 5
    0
      archiver/__init__.py
  3. 153
    0
      doc/Makefile
  4. 286
    0
      doc/conf/conf.py
  5. 5
    0
      doc/extra/testing.rst
  6. 21
    0
      index.rst
  7. 4742
    0
      web/static/css/_bootstrap.css

+ 1
- 0
.gitignore View File

@@ -3,3 +3,4 @@
3 3
 *.sqlite
4 4
 secret_key.py
5 5
 Melodia/cache
6
+doc/build/*

+ 5
- 0
archiver/__init__.py View File

@@ -0,0 +1,5 @@
1
+'''
2
+.. py:currentmodule:: 
3
+
4
+   :synopsis: Archiving back-end for the Melodia system.
5
+'''

+ 153
- 0
doc/Makefile View File

@@ -0,0 +1,153 @@
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) -c conf ../
14
+# the i18n builder cannot share the environment and doctrees with the others
15
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
16
+
17
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
18
+
19
+help:
20
+	@echo "Please use \`make <target>' where <target> is one of"
21
+	@echo "  html       to make standalone HTML files"
22
+	@echo "  dirhtml    to make HTML files named index.html in directories"
23
+	@echo "  singlehtml to make a single large HTML file"
24
+	@echo "  pickle     to make pickle files"
25
+	@echo "  json       to make JSON files"
26
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
27
+	@echo "  qthelp     to make HTML files and a qthelp project"
28
+	@echo "  devhelp    to make HTML files and a Devhelp project"
29
+	@echo "  epub       to make an epub"
30
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
31
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
32
+	@echo "  text       to make text files"
33
+	@echo "  man        to make manual pages"
34
+	@echo "  texinfo    to make Texinfo files"
35
+	@echo "  info       to make Texinfo files and run them through makeinfo"
36
+	@echo "  gettext    to make PO message catalogs"
37
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
38
+	@echo "  linkcheck  to check all external links for integrity"
39
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
40
+
41
+clean:
42
+	-rm -rf $(BUILDDIR)/*
43
+
44
+html:
45
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
46
+	@echo
47
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
48
+
49
+dirhtml:
50
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
51
+	@echo
52
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
53
+
54
+singlehtml:
55
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
56
+	@echo
57
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
58
+
59
+pickle:
60
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
61
+	@echo
62
+	@echo "Build finished; now you can process the pickle files."
63
+
64
+json:
65
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
66
+	@echo
67
+	@echo "Build finished; now you can process the JSON files."
68
+
69
+htmlhelp:
70
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
71
+	@echo
72
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
73
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
74
+
75
+qthelp:
76
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
77
+	@echo
78
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
79
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
80
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Melodia.qhcp"
81
+	@echo "To view the help file:"
82
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Melodia.qhc"
83
+
84
+devhelp:
85
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
86
+	@echo
87
+	@echo "Build finished."
88
+	@echo "To view the help file:"
89
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/Melodia"
90
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Melodia"
91
+	@echo "# devhelp"
92
+
93
+epub:
94
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
95
+	@echo
96
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
97
+
98
+latex:
99
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
100
+	@echo
101
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
102
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
103
+	      "(use \`make latexpdf' here to do that automatically)."
104
+
105
+latexpdf:
106
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
107
+	@echo "Running LaTeX files through pdflatex..."
108
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
109
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
110
+
111
+text:
112
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
113
+	@echo
114
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
115
+
116
+man:
117
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
118
+	@echo
119
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
120
+
121
+texinfo:
122
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
123
+	@echo
124
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
125
+	@echo "Run \`make' in that directory to run these through makeinfo" \
126
+	      "(use \`make info' here to do that automatically)."
127
+
128
+info:
129
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
130
+	@echo "Running Texinfo files through makeinfo..."
131
+	make -C $(BUILDDIR)/texinfo info
132
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
133
+
134
+gettext:
135
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
136
+	@echo
137
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
138
+
139
+changes:
140
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
141
+	@echo
142
+	@echo "The overview file is in $(BUILDDIR)/changes."
143
+
144
+linkcheck:
145
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
146
+	@echo
147
+	@echo "Link check complete; look for any errors in the above output " \
148
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
149
+
150
+doctest:
151
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
152
+	@echo "Testing of doctests in the sources finished, look at the " \
153
+	      "results in $(BUILDDIR)/doctest/output.txt."

+ 286
- 0
doc/conf/conf.py View File

@@ -0,0 +1,286 @@
1
+# -*- coding: utf-8 -*-
2
+#
3
+# Melodia documentation build configuration file, created by
4
+# sphinx-quickstart on Thu May  9 17:26:27 2013.
5
+#
6
+# This file is execfile()d with the current directory set to its containing dir.
7
+#
8
+# Note that not all possible configuration values are present in this
9
+# autogenerated file.
10
+#
11
+# All configuration values have a default; values that are commented out
12
+# serve to show the default.
13
+
14
+import sys, os
15
+
16
+# If extensions (or modules to document with autodoc) are in another directory,
17
+# add these directories to sys.path here. If the directory is relative to the
18
+# documentation root, use os.path.abspath to make it absolute, like shown here.
19
+#sys.path.insert(0, os.path.abspath('.'))
20
+sys.path.insert(0, os.path.abspath('../..')) # Django project root
21
+
22
+# -- General configuration -----------------------------------------------------
23
+
24
+# If your documentation needs a minimal Sphinx version, state it here.
25
+#needs_sphinx = '1.0'
26
+
27
+# Add any Sphinx extension module names here, as strings. They can be extensions
28
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
29
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
30
+
31
+# Add any paths that contain templates here, relative to this directory.
32
+templates_path = ['_templates']
33
+
34
+# The suffix of source filenames.
35
+source_suffix = '.rst'
36
+
37
+# The encoding of source files.
38
+#source_encoding = 'utf-8-sig'
39
+
40
+# The master toctree document.
41
+master_doc = 'index'
42
+
43
+# General information about the project.
44
+project = u'Melodia'
45
+copyright = u'2013, Bradlee Speice'
46
+
47
+# The version info for the project you're documenting, acts as replacement for
48
+# |version| and |release|, also used in various other places throughout the
49
+# built documents.
50
+#
51
+# The short X.Y version.
52
+version = '.1'
53
+# The full version, including alpha/beta/rc tags.
54
+release = '.1'
55
+
56
+# The language for content autogenerated by Sphinx. Refer to documentation
57
+# for a list of supported languages.
58
+#language = None
59
+
60
+# There are two options for replacing |today|: either, you set today to some
61
+# non-false value, then it is used:
62
+#today = ''
63
+# Else, today_fmt is used as the format for a strftime call.
64
+#today_fmt = '%B %d, %Y'
65
+
66
+# List of patterns, relative to source directory, that match files and
67
+# directories to ignore when looking for source files.
68
+exclude_patterns = []
69
+
70
+# The reST default role (used for this markup: `text`) to use for all documents.
71
+#default_role = None
72
+
73
+# If true, '()' will be appended to :func: etc. cross-reference text.
74
+#add_function_parentheses = True
75
+
76
+# If true, the current module name will be prepended to all description
77
+# unit titles (such as .. function::).
78
+#add_module_names = True
79
+
80
+# If true, sectionauthor and moduleauthor directives will be shown in the
81
+# output. They are ignored by default.
82
+#show_authors = False
83
+
84
+# The name of the Pygments (syntax highlighting) style to use.
85
+pygments_style = 'sphinx'
86
+
87
+# A list of ignored prefixes for module index sorting.
88
+#modindex_common_prefix = []
89
+
90
+
91
+# -- Options for HTML output ---------------------------------------------------
92
+
93
+# The theme to use for HTML and HTML Help pages.  See the documentation for
94
+# a list of builtin themes.
95
+html_theme = 'default'
96
+
97
+# Theme options are theme-specific and customize the look and feel of a theme
98
+# further.  For a list of options available for each theme, see the
99
+# documentation.
100
+#html_theme_options = {}
101
+
102
+# Add any paths that contain custom themes here, relative to this directory.
103
+#html_theme_path = []
104
+
105
+# The name for this set of Sphinx documents.  If None, it defaults to
106
+# "<project> v<release> documentation".
107
+#html_title = None
108
+
109
+# A shorter title for the navigation bar.  Default is the same as html_title.
110
+#html_short_title = None
111
+
112
+# The name of an image file (relative to this directory) to place at the top
113
+# of the sidebar.
114
+#html_logo = None
115
+
116
+# The name of an image file (within the static path) to use as favicon of the
117
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
118
+# pixels large.
119
+#html_favicon = None
120
+
121
+# Add any paths that contain custom static files (such as style sheets) here,
122
+# relative to this directory. They are copied after the builtin static files,
123
+# so a file named "default.css" will overwrite the builtin "default.css".
124
+html_static_path = ['_static']
125
+
126
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
127
+# using the given strftime format.
128
+#html_last_updated_fmt = '%b %d, %Y'
129
+
130
+# If true, SmartyPants will be used to convert quotes and dashes to
131
+# typographically correct entities.
132
+#html_use_smartypants = True
133
+
134
+# Custom sidebar templates, maps document names to template names.
135
+#html_sidebars = {}
136
+
137
+# Additional templates that should be rendered to pages, maps page names to
138
+# template names.
139
+#html_additional_pages = {}
140
+
141
+# If false, no module index is generated.
142
+#html_domain_indices = True
143
+
144
+# If false, no index is generated.
145
+#html_use_index = True
146
+
147
+# If true, the index is split into individual pages for each letter.
148
+#html_split_index = False
149
+
150
+# If true, links to the reST sources are added to the pages.
151
+#html_show_sourcelink = True
152
+
153
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
154
+#html_show_sphinx = True
155
+
156
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
157
+#html_show_copyright = True
158
+
159
+# If true, an OpenSearch description file will be output, and all pages will
160
+# contain a <link> tag referring to it.  The value of this option must be the
161
+# base URL from which the finished HTML is served.
162
+#html_use_opensearch = ''
163
+
164
+# This is the file name suffix for HTML files (e.g. ".xhtml").
165
+#html_file_suffix = None
166
+
167
+# Output file base name for HTML help builder.
168
+htmlhelp_basename = 'Melodiadoc'
169
+
170
+
171
+# -- Options for LaTeX output --------------------------------------------------
172
+
173
+latex_elements = {
174
+# The paper size ('letterpaper' or 'a4paper').
175
+#'papersize': 'letterpaper',
176
+
177
+# The font size ('10pt', '11pt' or '12pt').
178
+#'pointsize': '10pt',
179
+
180
+# Additional stuff for the LaTeX preamble.
181
+#'preamble': '',
182
+}
183
+
184
+# Grouping the document tree into LaTeX files. List of tuples
185
+# (source start file, target name, title, author, documentclass [howto/manual]).
186
+latex_documents = [
187
+  ('index', 'Melodia.tex', u'Melodia Documentation',
188
+   u'Bradlee Speice', 'manual'),
189
+]
190
+
191
+# The name of an image file (relative to this directory) to place at the top of
192
+# the title page.
193
+#latex_logo = None
194
+
195
+# For "manual" documents, if this is true, then toplevel headings are parts,
196
+# not chapters.
197
+#latex_use_parts = False
198
+
199
+# If true, show page references after internal links.
200
+#latex_show_pagerefs = False
201
+
202
+# If true, show URL addresses after external links.
203
+#latex_show_urls = False
204
+
205
+# Documents to append as an appendix to all manuals.
206
+#latex_appendices = []
207
+
208
+# If false, no module index is generated.
209
+#latex_domain_indices = True
210
+
211
+
212
+# -- Options for manual page output --------------------------------------------
213
+
214
+# One entry per manual page. List of tuples
215
+# (source start file, name, description, authors, manual section).
216
+man_pages = [
217
+    ('index', 'melodia', u'Melodia Documentation',
218
+     [u'Bradlee Speice'], 1)
219
+]
220
+
221
+# If true, show URL addresses after external links.
222
+#man_show_urls = False
223
+
224
+
225
+# -- Options for Texinfo output ------------------------------------------------
226
+
227
+# Grouping the document tree into Texinfo files. List of tuples
228
+# (source start file, target name, title, author,
229
+#  dir menu entry, description, category)
230
+texinfo_documents = [
231
+  ('index', 'Melodia', u'Melodia Documentation',
232
+   u'Bradlee Speice', 'Melodia', 'One line description of project.',
233
+   'Miscellaneous'),
234
+]
235
+
236
+# Documents to append as an appendix to all manuals.
237
+#texinfo_appendices = []
238
+
239
+# If false, no module index is generated.
240
+#texinfo_domain_indices = True
241
+
242
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
243
+#texinfo_show_urls = 'footnote'
244
+
245
+
246
+# -- Options for Epub output ---------------------------------------------------
247
+
248
+# Bibliographic Dublin Core info.
249
+epub_title = u'Melodia'
250
+epub_author = u'Bradlee Speice'
251
+epub_publisher = u'Bradlee Speice'
252
+epub_copyright = u'2013, Bradlee Speice'
253
+
254
+# The language of the text. It defaults to the language option
255
+# or en if the language is not set.
256
+#epub_language = ''
257
+
258
+# The scheme of the identifier. Typical schemes are ISBN or URL.
259
+#epub_scheme = ''
260
+
261
+# The unique identifier of the text. This can be a ISBN number
262
+# or the project homepage.
263
+#epub_identifier = ''
264
+
265
+# A unique identification for the text.
266
+#epub_uid = ''
267
+
268
+# A tuple containing the cover image and cover page html template filenames.
269
+#epub_cover = ()
270
+
271
+# HTML files that should be inserted before the pages created by sphinx.
272
+# The format is a list of tuples containing the path and title.
273
+#epub_pre_files = []
274
+
275
+# HTML files shat should be inserted after the pages created by sphinx.
276
+# The format is a list of tuples containing the path and title.
277
+#epub_post_files = []
278
+
279
+# A list of files that should not be packed into the epub file.
280
+#epub_exclude_files = []
281
+
282
+# The depth of the table of contents in toc.ncx.
283
+#epub_tocdepth = 3
284
+
285
+# Allow duplicate toc entries.
286
+#epub_tocdup = True

+ 5
- 0
doc/extra/testing.rst View File

@@ -0,0 +1,5 @@
1
+====
2
+Extra documentation file
3
+====
4
+
5
+Place extra documentation here.

+ 21
- 0
index.rst View File

@@ -0,0 +1,21 @@
1
+.. Melodia documentation master file, created by
2
+   sphinx-quickstart on Thu May  9 17:26:27 2013.
3
+   You can adapt this file completely to your liking, but it should at least
4
+   contain the root `toctree` directive.
5
+
6
+Welcome to Melodia's documentation!
7
+===================================
8
+
9
+Contents:
10
+
11
+.. toctree::
12
+   :maxdepth: 2
13
+   :glob:
14
+
15
+   doc/extra/*
16
+
17
+.. automodule:: archiver
18
+   :members:
19
+
20
+.. automodule:: web
21
+   :members:

+ 4742
- 0
web/static/css/_bootstrap.css
File diff suppressed because it is too large
View File


Loading…
Cancel
Save