diff options
| -rw-r--r-- | nerv/doc/Makefile | 17 | ||||
| -rw-r--r-- | nerv/doc/source/conf.py | 46 | ||||
| -rw-r--r-- | nerv/doc/source/dev.rst | 3 | ||||
| -rw-r--r-- | nerv/doc/source/index.rst | 5 | ||||
| -rw-r--r-- | nerv/doc/source/user.rst | 3 |
5 files changed, 61 insertions, 13 deletions
diff --git a/nerv/doc/Makefile b/nerv/doc/Makefile index 81a66e9..39b1116 100644 --- a/nerv/doc/Makefile +++ b/nerv/doc/Makefile @@ -19,7 +19,7 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) sou # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext help: @echo "Please use \`make <target>' where <target> is one of" @@ -30,6 +30,7 @@ help: @echo " json to make JSON files" @echo " htmlhelp to make HTML files and a HTML help project" @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" @echo " devhelp to make HTML files and a Devhelp project" @echo " epub to make an epub" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @@ -45,6 +46,7 @@ help: @echo " pseudoxml to make pseudoxml-XML files for display purposes" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" clean: rm -rf $(BUILDDIR)/* @@ -89,6 +91,14 @@ qthelp: @echo "To view the help file:" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Nerv.qhc" +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @@ -166,6 +176,11 @@ doctest: @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + xml: $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml @echo diff --git a/nerv/doc/source/conf.py b/nerv/doc/source/conf.py index a3df043..8426613 100644 --- a/nerv/doc/source/conf.py +++ b/nerv/doc/source/conf.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # # Nerv documentation build configuration file, created by -# sphinx-quickstart on Sun Jun 21 00:55:25 2015. +# sphinx-quickstart on Thu Jun 25 19:40:07 2015. # # This file is execfile()d with the current directory set to its # containing dir. @@ -14,6 +14,7 @@ import sys import os +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 @@ -36,7 +37,9 @@ extensions = [ # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] -# The suffix of source filenames. +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# source_suffix = ['.rst', '.md'] source_suffix = '.rst' # The encoding of source files. @@ -48,6 +51,7 @@ master_doc = 'index' # General information about the project. project = u'Nerv' copyright = u'2015, Ted Yin, Tianxing He' +author = u'Ted Yin, Tianxing He' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -60,7 +64,10 @@ release = 'alpha' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -96,12 +103,15 @@ pygments_style = 'sphinx' # If true, keep warnings as "system message" paragraphs in the built documents. #keep_warnings = False +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'haiku' +html_theme = 'alabaster' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -178,10 +188,23 @@ html_static_path = ['_static'] # This is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = None +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +#html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +#html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +#html_search_scorer = 'scorer.js' + # Output file base name for HTML help builder. htmlhelp_basename = 'Nervdoc' - # -- Options for LaTeX output --------------------------------------------- latex_elements = { @@ -193,13 +216,16 @@ latex_elements = { # Additional stuff for the LaTeX preamble. #'preamble': '', + +# Latex figure (float) alignment +#'figure_align': 'htbp', } # 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 = [ - ('index', 'Nerv.tex', u'Nerv Documentation', + (master_doc, 'Nerv.tex', u'Nerv Documentation', u'Ted Yin, Tianxing He', 'manual'), ] @@ -229,8 +255,8 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'nerv', u'Nerv Documentation', - [u'Ted Yin, Tianxing He'], 1) + (master_doc, 'nerv', u'Nerv Documentation', + [author], 1) ] # If true, show URL addresses after external links. @@ -243,8 +269,8 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'Nerv', u'Nerv Documentation', - u'Ted Yin, Tianxing He', 'Nerv', 'One line description of project.', + (master_doc, 'Nerv', u'Nerv Documentation', + author, 'Nerv', 'One line description of project.', 'Miscellaneous'), ] diff --git a/nerv/doc/source/dev.rst b/nerv/doc/source/dev.rst new file mode 100644 index 0000000..30311a2 --- /dev/null +++ b/nerv/doc/source/dev.rst @@ -0,0 +1,3 @@ +Development Manual +================== +To be filled. diff --git a/nerv/doc/source/index.rst b/nerv/doc/source/index.rst index 6881eb1..8bb23c7 100644 --- a/nerv/doc/source/index.rst +++ b/nerv/doc/source/index.rst @@ -1,5 +1,5 @@ .. Nerv documentation master file, created by - sphinx-quickstart on Sun Jun 21 00:55:25 2015. + sphinx-quickstart on Thu Jun 25 19:40:07 2015. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. @@ -11,7 +11,8 @@ Contents: .. toctree:: :maxdepth: 2 - + user + dev Indices and tables ================== diff --git a/nerv/doc/source/user.rst b/nerv/doc/source/user.rst new file mode 100644 index 0000000..eb4b53c --- /dev/null +++ b/nerv/doc/source/user.rst @@ -0,0 +1,3 @@ +User Manual +=========== +To be filled. |