Skip to content

Commit

Permalink
Switched from using automodapi to sphinx.ext.autodoc.
Browse files Browse the repository at this point in the history
  • Loading branch information
tmcclintock committed Nov 20, 2017
1 parent 1e98f4f commit 3a3ad4f
Show file tree
Hide file tree
Showing 10 changed files with 11 additions and 55 deletions.
6 changes: 0 additions & 6 deletions docs/api/cluster_toolkit.bias.bias_at_M.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/api/cluster_toolkit.bias.bias_at_R.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/api/cluster_toolkit.bias.bias_at_nu.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/api/cluster_toolkit.bias.nu_at_M.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/api/cluster_toolkit.bias.nu_at_R.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/api/cluster_toolkit.bias.sigma2_at_M.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/api/cluster_toolkit.bias.sigma2_at_R.rst

This file was deleted.

4 changes: 2 additions & 2 deletions docs/cluster_toolkit_full_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Comprehensive Cluster Toolkit Reference/API
******************************************************

.. automodapi:: cluster_toolkit.bias
:no-inheritance-diagram:
.. automodule:: cluster_toolkit.bias
:members:
19 changes: 9 additions & 10 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,13 @@
import os
import sys
sys.path.insert(0, os.path.abspath('../cluster_toolkit/bias.py'))
from mock import Mock as MagicMock
class Mock(MagicMock):
@classmethod
def __getattr__(cls, name):
return MagicMock()
MOCK_MODULES = ['cluster_toolkit._lib', 'cluster_toolkit._ffi']
sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)

#from mock import Mock as MagicMock
#class Mock(MagicMock):
# @classmethod
# def __getattr__(cls, name):
# return MagicMock()
#MOCK_MODULES = ['cluster_toolkit._lib', 'cluster_toolkit._ffi']
#sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)


# -- General configuration ------------------------------------------------
Expand All @@ -40,7 +39,7 @@ def __getattr__(cls, name):
# ones.
extensions = ['sphinx.ext.todo',
'sphinx.ext.mathjax',
'sphinx_automodapi.automodapi',
'sphinx.ext.autodoc',
'sphinxcontrib.napoleon']

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -164,7 +163,7 @@ def __getattr__(cls, name):
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'cluster_wl', u'cluster_toolkit Documentation',
(master_doc, 'cluster_toolkit', u'cluster_toolkit Documentation',
[author], 1)
]

Expand Down
1 change: 0 additions & 1 deletion docs/rtd-pip-requirements
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
sphinx-automodapi
sphinxcontrib-napoleon

0 comments on commit 3a3ad4f

Please sign in to comment.