Skip to content

Commit 678c1e5

Browse files
ddaleddale
committed
move docs into new infrastructure, using numpydoc
1 parent a25fe1c commit 678c1e5

21 files changed

Lines changed: 475 additions & 12 deletions

‎.bzrignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@ build
33
dist
44
.eric4project/project-apis.db
55
.ropeproject/objectdb
6-
doc/source/reference/generated
6+
doc/reference/generated
7+
doc/_build/*

‎doc/Makefile‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
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 pickle json htmlhelp qthelp latex 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 " pickle to make pickle files"
22+
@echo " json to make JSON files"
23+
@echo " htmlhelp to make HTML files and a HTML help project"
24+
@echo " qthelp to make HTML files and a qthelp project"
25+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
26+
@echo " changes to make an overview of all changed/added/deprecated items"
27+
@echo " linkcheck to check all external links for integrity"
28+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
29+
30+
clean:
31+
-rm -rf $(BUILDDIR)/*
32+
33+
html:
34+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
35+
@echo
36+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
37+
38+
dirhtml:
39+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
40+
@echo
41+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
42+
43+
pickle:
44+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
45+
@echo
46+
@echo "Build finished; now you can process the pickle files."
47+
48+
json:
49+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
50+
@echo
51+
@echo "Build finished; now you can process the JSON files."
52+
53+
htmlhelp:
54+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
55+
@echo
56+
@echo "Build finished; now you can run HTML Help Workshop with the" \
57+
".hhp project file in $(BUILDDIR)/htmlhelp."
58+
59+
qthelp:
60+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
61+
@echo
62+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
63+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
64+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/quantities.qhcp"
65+
@echo "To view the help file:"
66+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/quantities.qhc"
67+
68+
latex:
69+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
70+
@echo
71+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
72+
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
73+
"run these through (pdf)latex."
74+
75+
changes:
76+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
77+
@echo
78+
@echo "The overview file is in $(BUILDDIR)/changes."
79+
80+
linkcheck:
81+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
82+
@echo
83+
@echo "Link check complete; look for any errors in the above output " \
84+
"or in $(BUILDDIR)/linkcheck/output.txt."
85+
86+
doctest:
87+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
88+
@echo "Testing of doctests in the sources finished, look at the " \
89+
"results in $(BUILDDIR)/doctest/output.txt."

‎doc/_templates/indexsidebar.html‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<h3>Download</h3>
2+
<p>Current version: <b>{{ version }}</b></p>
3+
<p>Get Quantities from the <a href="http://pypi.python.org/pypi/quantities">
4+
Python Package Index</a>
5+
6+
<h3>Questions? Suggestions? Contributions?</h3>
7+
8+
<p>Visit the
9+
<a href="https://launchpad.net/python-quantities">Quantities project page at launchpad</a>
10+
</p>
11+

‎doc/conf.py‎

Lines changed: 204 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,204 @@
1+
# -*- coding: utf-8 -*-
2+
#
3+
# quantities documentation build configuration file, created by
4+
# sphinx-quickstart on Sun Oct 25 09:49:05 2009.
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.append(os.path.abspath('./sphinxext'))
20+
21+
# -- General configuration -----------------------------------------------------
22+
23+
# Add any Sphinx extension module names here, as strings. They can be extensions
24+
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
25+
extensions = [
26+
'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo',
27+
'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig',
28+
'sphinx.ext.autosummary', 'ipython_console_highlighting', 'numpydoc.numpydoc'
29+
]
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'
39+
40+
# The master toctree document.
41+
master_doc = 'index'
42+
43+
# General information about the project.
44+
project = u'quantities'
45+
copyright = u'2009, Darren Dale'
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+
import quantities
52+
# The short X.Y version.
53+
version = quantities.__version__
54+
# The full version, including alpha/beta/rc tags.
55+
release = quantities.__version__
56+
57+
# The language for content autogenerated by Sphinx. Refer to documentation
58+
# for a list of supported languages.
59+
#language = None
60+
61+
# There are two options for replacing |today|: either, you set today to some
62+
# non-false value, then it is used:
63+
#today = ''
64+
# Else, today_fmt is used as the format for a strftime call.
65+
#today_fmt = '%B %d, %Y'
66+
67+
# List of documents that shouldn't be included in the build.
68+
#unused_docs = []
69+
70+
# List of directories, relative to source directory, that shouldn't be searched
71+
# for source files.
72+
exclude_trees = ['_build']
73+
74+
# The reST default role (used for this markup: `text`) to use for all documents.
75+
#default_role = None
76+
77+
# If true, '()' will be appended to :func: etc. cross-reference text.
78+
#add_function_parentheses = True
79+
80+
# If true, the current module name will be prepended to all description
81+
# unit titles (such as .. function::).
82+
#add_module_names = True
83+
84+
# If true, sectionauthor and moduleauthor directives will be shown in the
85+
# output. They are ignored by default.
86+
#show_authors = False
87+
88+
# The name of the Pygments (syntax highlighting) style to use.
89+
pygments_style = 'sphinx'
90+
91+
# A list of ignored prefixes for module index sorting.
92+
#modindex_common_prefix = []
93+
94+
autosummary_generate = ['reference/intro.rst']
95+
96+
# -- Options for HTML output ---------------------------------------------------
97+
98+
# The theme to use for HTML and HTML Help pages. Major themes that come with
99+
# Sphinx are currently 'default' and 'sphinxdoc'.
100+
html_theme = 'sphinxdoc'
101+
102+
# Theme options are theme-specific and customize the look and feel of a theme
103+
# further. For a list of options available for each theme, see the
104+
# documentation.
105+
#html_theme_options = {}
106+
107+
# Add any paths that contain custom themes here, relative to this directory.
108+
#html_theme_path = []
109+
110+
# The name for this set of Sphinx documents. If None, it defaults to
111+
# "<project> v<release> documentation".
112+
#html_title = None
113+
114+
# A shorter title for the navigation bar. Default is the same as html_title.
115+
#html_short_title = None
116+
117+
# The name of an image file (relative to this directory) to place at the top
118+
# of the sidebar.
119+
#html_logo = None
120+
121+
# The name of an image file (within the static path) to use as favicon of the
122+
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
123+
# pixels large.
124+
#html_favicon = None
125+
126+
# Add any paths that contain custom static files (such as style sheets) here,
127+
# relative to this directory. They are copied after the builtin static files,
128+
# so a file named "default.css" will overwrite the builtin "default.css".
129+
html_static_path = ['_static']
130+
131+
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
132+
# using the given strftime format.
133+
#html_last_updated_fmt = '%b %d, %Y'
134+
135+
# If true, SmartyPants will be used to convert quotes and dashes to
136+
# typographically correct entities.
137+
html_use_smartypants = True
138+
139+
# Custom sidebar templates, maps document names to template names.
140+
#html_sidebars = {}
141+
142+
# Additional templates that should be rendered to pages, maps page names to
143+
# template names.
144+
html_sidebars = {'index': 'indexsidebar.html'}
145+
146+
# If false, no module index is generated.
147+
#html_use_modindex = True
148+
149+
# If false, no index is generated.
150+
#html_use_index = True
151+
152+
# If true, the index is split into individual pages for each letter.
153+
#html_split_index = False
154+
155+
# If true, links to the reST sources are added to the pages.
156+
#html_show_sourcelink = 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+
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
164+
#html_file_suffix = ''
165+
166+
# Output file base name for HTML help builder.
167+
htmlhelp_basename = 'quantitiesdoc'
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', 'quantities.tex', u'quantities Documentation',
182+
u'Darren Dale', '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+
# Additional stuff for the LaTeX preamble.
194+
#latex_preamble = ''
195+
196+
# Documents to append as an appendix to all manuals.
197+
#latex_appendices = []
198+
199+
# If false, no module index is generated.
200+
#latex_use_modindex = True
201+
202+
203+
# Example configuration for intersphinx: refer to the Python standard library.
204+
intersphinx_mapping = {'http://docs.python.org/': None}

doc.backup/source/devel/devnotes.rst renamed to doc/devel/devnotes.rst

File renamed without changes.

doc.backup/source/devel/documenting.rst renamed to doc/devel/documenting.rst

File renamed without changes.

doc.backup/source/devel/index.rst renamed to doc/devel/index.rst

File renamed without changes.

doc.backup/source/devel/release.rst renamed to doc/devel/release.rst

File renamed without changes.

doc.backup/source/glossary.rst renamed to doc/glossary.rst

File renamed without changes.

‎doc/index.rst‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
2+
.. only:: html
3+
4+
:Release: |version|
5+
:Date: |today|
6+
7+
.. Download `PDF <./Quantities.pdf>`_
8+
9+
.. _contents:
10+
11+
Quantities
12+
==========
13+
14+
Quantities is designed to handle arithmetic and conversions of physical
15+
quantities, which have a magnitude, dimensionality specified by various units,
16+
and possibly an uncertainty. Quantities builds on the popular numpy library
17+
and is designed to work with numpy's standard ufuncs, many of which are
18+
already supported.
19+
20+
Quantities is actively developed, and while the current features and API are
21+
stable, test coverage is incomplete and the package is not ready for
22+
production use.
23+
24+
.. toctree::
25+
:maxdepth: 2
26+
27+
user/index.rst
28+
devel/index.rst
29+
reference/index.rst
30+
glossary.rst

0 commit comments

Comments
 (0)