Skip to content

Commit 47f9546

Browse files
iwilligiwillig
committed
Added docs, migrations and pshell short cut.
1 parent b70b814 commit 47f9546

File tree

6 files changed

+1556
-0
lines changed

6 files changed

+1556
-0
lines changed

‎docs/Makefile

+130
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/SharedSolar.qhcp"
76+
@echo "To view the help file:"
77+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SharedSolar.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/SharedSolar"
85+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SharedSolar"
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."

‎docs/conf.py

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

0 commit comments

Comments
 (0)