diff options
author | Andy McCurdy <andy@andymccurdy.com> | 2016-09-10 02:01:05 -0700 |
---|---|---|
committer | Andy McCurdy <andy@andymccurdy.com> | 2016-09-10 02:01:05 -0700 |
commit | a87ae0ddb5b591f15527312229a7c92284012a5b (patch) | |
tree | 71a00ee69a93e6a9d90768988263ff0d56cf6f80 | |
parent | dc56e5f3160e55d6272b024c4768bbc3c327d72b (diff) | |
download | redis-py-a87ae0ddb5b591f15527312229a7c92284012a5b.tar.gz |
get docs working again
-rw-r--r-- | docs/conf.py | 20 | ||||
-rw-r--r-- | docs/index.rst | 19 |
2 files changed, 23 insertions, 16 deletions
diff --git a/docs/conf.py b/docs/conf.py index 8463eaa..690be03 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,6 +19,7 @@ import sys # 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('.')) +sys.path.append(os.path.abspath(os.path.pardir)) # -- General configuration ---------------------------------------------------- @@ -27,7 +28,7 @@ import sys # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = [] +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.viewcode'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -43,16 +44,16 @@ master_doc = 'index' # General information about the project. project = u'redis-py' -copyright = u'2013, Andy McCurdy, Mahdi Yusuf' +copyright = u'2016, Andy McCurdy' # 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 = '2.7.2' +version = '2.10.5' # The full version, including alpha/beta/rc tags. -release = '2.7.2' +release = '2.10.5' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -188,7 +189,7 @@ latex_elements = { # [howto/manual]). latex_documents = [ ('index', 'redis-py.tex', u'redis-py Documentation', - u'Andy McCurdy, Mahdi Yusuf', 'manual'), + u'Andy McCurdy', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -218,7 +219,7 @@ latex_documents = [ # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'redis-py', u'redis-py Documentation', - [u'Andy McCurdy, Mahdi Yusuf'], 1) + [u'Andy McCurdy'], 1) ] # If true, show URL addresses after external links. @@ -232,7 +233,7 @@ man_pages = [ # dir menu entry, description, category) texinfo_documents = [ ('index', 'redis-py', u'redis-py Documentation', - u'Andy McCurdy, Mahdi Yusuf', 'redis-py', + u'Andy McCurdy', 'redis-py', 'One line description of project.', 'Miscellaneous'), ] @@ -244,3 +245,8 @@ texinfo_documents = [ # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' + +epub_title = u'redis-py' +epub_author = u'Andy McCurdy' +epub_publisher = u'Andy McCurdy' +epub_copyright = u'2011, Andy McCurdy' diff --git a/docs/index.rst b/docs/index.rst index 2394587..e441bee 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,22 +1,23 @@ .. redis-py documentation master file, created by - sphinx-quickstart on Fri Feb 8 00:47:08 2013. + sphinx-quickstart on Thu Jul 28 13:55:57 2011. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to redis-py's documentation! ==================================== -Contents: - -.. toctree:: - :maxdepth: 2 - - - Indices and tables -================== +------------------ * :ref:`genindex` * :ref:`modindex` * :ref:`search` +Contents: +--------- + +.. toctree:: + :maxdepth: 2 + +.. automodule:: redis + :members: |