X-Git-Url: http://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=doc%2Fsource%2Fconf.py;h=07d1b3d49252db3c5c844aa5377f732a007b1bd1;hb=64239701d2dcabf49a854f5680fb7b1ef652ae8f;hp=62ac53045f9af61001520f56e891484f83bbda3d;hpb=788291920a447be16af9f330973816b6ca56c7b0;p=dunshire.git diff --git a/doc/source/conf.py b/doc/source/conf.py index 62ac530..07d1b3d 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -7,21 +7,24 @@ import shlex # 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.coverage', - 'sphinx.ext.pngmath', + 'sphinx.ext.doctest', + 'sphinx.ext.mathjax', + 'sphinx.ext.napoleon', '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 +# the (much faster) unittest test suite. +doctest_test_doctest_blocks = '' # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: @@ -37,10 +40,10 @@ copyright = '2016, Michael Orlitzky' 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. @@ -111,14 +114,16 @@ htmlhelp_basename = 'dunshiredoc' # -- 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 --------------------------------------- @@ -126,7 +131,7 @@ latex_documents = [ # 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) ] @@ -140,7 +145,7 @@ man_pages = [ # (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'), ]