diff --git a/doc/conf.py b/doc/conf.py index 7e1ec813..80cd5602 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # # GPy documentation build configuration file, created by -# sphinx-quickstart on Wed Jan 9 15:21:20 2013. +# sphinx-quickstart on Fri Jan 18 15:30:28 2013. # # This file is execfile()d with the current directory set to its containing dir. # @@ -25,7 +25,7 @@ import sys, os # 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.todo', 'sphinx.ext.pngmath', 'sphinx.ext.mathjax', 'sphinx.ext.viewcode'] +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -41,16 +41,16 @@ master_doc = 'index' # General information about the project. project = u'GPy' -copyright = u'2013, The GPy authors' +copyright = u'2013, Author' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '0.00001' +version = '' # The full version, including alpha/beta/rc tags. -release = '0.00001' +release = '' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -184,7 +184,7 @@ latex_elements = { # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', 'GPy.tex', u'GPy Documentation', - u'The GPy authors', 'manual'), + u'Author', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -214,7 +214,7 @@ latex_documents = [ # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'gpy', u'GPy Documentation', - [u'The GPy authors'], 1) + [u'Author'], 1) ] # If true, show URL addresses after external links. @@ -228,7 +228,7 @@ man_pages = [ # dir menu entry, description, category) texinfo_documents = [ ('index', 'GPy', u'GPy Documentation', - u'The GPy authors', 'GPy', 'One line description of project.', + u'Author', 'GPy', 'One line description of project.', 'Miscellaneous'), ] @@ -240,3 +240,53 @@ texinfo_documents = [ # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' + + +# -- Options for Epub output --------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = u'GPy' +epub_author = u'Author' +epub_publisher = u'Author' +epub_copyright = u'2013, Author' + +# The language of the text. It defaults to the language option +# or en if the language is not set. +#epub_language = '' + +# The scheme of the identifier. Typical schemes are ISBN or URL. +#epub_scheme = '' + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +#epub_identifier = '' + +# A unique identification for the text. +#epub_uid = '' + +# A tuple containing the cover image and cover page html template filenames. +#epub_cover = () + +# HTML files that should be inserted before the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_pre_files = [] + +# HTML files shat should be inserted after the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_post_files = [] + +# A list of files that should not be packed into the epub file. +#epub_exclude_files = [] + +# The depth of the table of contents in toc.ncx. +#epub_tocdepth = 3 + +# Allow duplicate toc entries. +#epub_tocdup = True + +# ----------------------- READTHEDOCS ------------------ +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +if on_rtd: + os.system("sphinx-apidoc -f -o . ../GPy") +#sphinx-apidoc . -o doc -H 'GPy' -f diff --git a/doc/index.rst b/doc/index.rst index 46327bb7..34d3e59c 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,16 +1,21 @@ .. GPy documentation master file, created by - sphinx-quickstart on Wed Jan 9 15:21:20 2013. + sphinx-quickstart on Fri Jan 18 15:30:28 2013. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to GPy's documentation! =============================== +Now what if I add this other hting +Just checking another thing + Contents: .. toctree:: - :maxdepth: 2 + :maxdepth: 4 + GPy + setup Indices and tables