Skip to content

Commit

Permalink
Trying to get the docstrings correct.
Browse files Browse the repository at this point in the history
  • Loading branch information
tmcclintock committed Nov 20, 2017
1 parent be84953 commit 31f0474
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 13 deletions.
4 changes: 2 additions & 2 deletions cluster_toolkit/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""clsuterwl
"""cluster_toolkit
You can find docstrings for each of the package contents by inspecting help(cluster_toolkit.PACKAGENAME). The package names include: xi, bias, deltasigma, miscentering, and boostfactors.
You can find docstrings for each of the package contents by inspecting help(cluster_toolkit.PACKAGENAME).
"""
import os, cffi, glob

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




in progress.. automodapi:: cluster_toolkit.bias
testing
.. automodapi:: cluster_toolkit.bias
19 changes: 13 additions & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,17 @@
# 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.
#
#import os
#import sys
#sys.path.insert(0, os.path.abspath('.'))
import os
import sys
sys.path.insert(0, os.path.abspath('../cluster_toolkit/'))
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 @@ -31,9 +39,8 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.todo',
'sphinx.ext.mathjax']#,
#'sphinx_automodapi.automodapi',
#'sphinxcontrib.napoleon']
'sphinx.ext.mathjax',
'sphinx_automodapi.automodapi','sphinxcontrib.napoleon']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ Comprehensive API
.. toctree::
:maxdepth: 1

will soon have: cluster_toolkit_full_api
cluster_toolkit_full_api

0 comments on commit 31f0474

Please sign in to comment.