diff --git a/cluster_toolkit/__init__.py b/cluster_toolkit/__init__.py index c9cc091..3db7d05 100644 --- a/cluster_toolkit/__init__.py +++ b/cluster_toolkit/__init__.py @@ -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 diff --git a/docs/cluster_toolkit_full_api.rst b/docs/cluster_toolkit_full_api.rst index 5376555..0fba6d8 100644 --- a/docs/cluster_toolkit_full_api.rst +++ b/docs/cluster_toolkit_full_api.rst @@ -2,7 +2,5 @@ Comprehensive Cluster Toolkit Reference/API ****************************************************** - - - -in progress.. automodapi:: cluster_toolkit.bias +testing +.. automodapi:: cluster_toolkit.bias diff --git a/docs/conf.py b/docs/conf.py index 9755194..5332ee2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 ------------------------------------------------ @@ -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'] diff --git a/docs/index.rst b/docs/index.rst index d546a71..5c2ad7a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -45,4 +45,4 @@ Comprehensive API .. toctree:: :maxdepth: 1 -will soon have: cluster_toolkit_full_api + cluster_toolkit_full_api