# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath('../../src/'))
-sys.path.insert(0, os.path.abspath('../../src/dunshire'))
+sys.path.insert(0, os.path.abspath('../../'))
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
- 'sphinx.ext.autosummary',
'sphinx.ext.doctest',
+ 'sphinx.ext.mathjax',
'sphinx.ext.napoleon',
- 'sphinx.ext.pngmath',
'sphinx.ext.viewcode',
]
-autosummary_generate = True
-
# Don't automatically test every >>> block in the documentation. This
# avoids testing the API docs as part of the documentation build,
# which is exactly what we intend, because those are tested as part of
author = 'Michael Orlitzky'
# The short X.Y version.
-version = '0.0.1'
+version = '0.1.0'
# The full version, including alpha/beta/rc tags.
-release = '0.0.1'
+release = '0.1.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
+ 'preamble' : '\usepackage{amsfonts,amssymb}',
+ 'printindex' : ''
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
- (master_doc, 'dunshire.tex', 'Dunshire Documentation',
- 'author', 'manual'),
+ (master_doc, 'dunshire.tex', project + ' Documentation',
+ author, 'manual'),
]
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
- (master_doc, 'Dunshire', 'Dunshire Documentation',
+ (master_doc, project, project + ' Documentation',
[author], 1)
]
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
- (master_doc, 'Dunshire', 'Dunshire Documentation',
+ (master_doc, project, project + ' Documentation',
author, 'derp', 'One line description of project.',
'Miscellaneous'),
]