diff options
Diffstat (limited to 'doc/conf.py')
| -rw-r--r-- | doc/conf.py | 62 |
1 files changed, 18 insertions, 44 deletions
diff --git a/doc/conf.py b/doc/conf.py index 490a01d..0f3e012 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -15,7 +15,8 @@ import sys, os # If extensions (or modules to document with autodoc) are in another directory, # 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.append(os.path.abspath(os.path.join('..', 'lmfit'))) +sys.path.insert(0, os.path.abspath('../')) +# sys.path.append(os.path.abspath(os.path.join('..', 'lmfit'))) sys.path.append(os.path.abspath(os.path.join('.', 'sphinx'))) sys.path.append(os.path.abspath(os.path.join('.'))) # -- General configuration ----------------------------------------------------- @@ -24,30 +25,23 @@ sys.path.append(os.path.abspath(os.path.join('.'))) # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. from extensions import extensions -extensions = [ - 'sphinx.ext.extlinks', - 'sphinx.ext.autodoc', - 'sphinx.ext.napoleon', - 'sphinx.ext.mathjax', - ] - -try: - import IPython.sphinxext.ipython_directive - extensions.extend(['IPython.sphinxext.ipython_directive', - 'IPython.sphinxext.ipython_console_highlighting']) -except ImportError: - pass - -intersphinx_mapping = {'py': ('http://docs.python.org/2', None), - 'numpy': ('http://docs.scipy.org/doc/numpy/', None), - 'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None), +ssoextensions = ['sphinx.ext.extlinks', + 'sphinx.ext.autodoc', + 'sphinx.ext.napoleon', + 'sphinx.ext.mathjax'] + +autoclass_content = 'both' + +intersphinx_mapping = {'py': ('https://docs.python.org/2', None), + 'numpy': ('https://docs.scipy.org/doc/numpy/', None), + 'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None), } ## intersphinx_cache_limit = 10 extlinks = { - 'scipydoc' : ('http://docs.scipy.org/doc/scipy/reference/generated/%s.html', ''), - 'numpydoc' : ('http://docs.scipy.org/doc/numpy/reference/generated/numpy.%s.html', ''), + 'scipydoc' : ('http://docs.scipy.org/doc/scipy/reference/generated/scipy.%s.html', 'scipy.'), + 'numpydoc' : ('http://docs.scipy.org/doc/numpy/reference/generated/numpy.%s.html', 'numpy.'), } # Add any paths that contain templates here, relative to this directory. @@ -64,33 +58,13 @@ master_doc = 'index' # General information about the project. project = u'lmfit' -copyright = u'2014, Matthew Newville, The University of Chicago, Till Stensitzki, Freie Universitat Berlin' +copyright = u'2017, Matthew Newville, The University of Chicago, Till Stensitzki, Freie Universitat Berlin' # 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. -sys.path.insert(0, os.path.abspath('../')) -try: - import lmfit - release = lmfit.__version__ -# The full version, including alpha/beta/rc tags. -except ImportError: - release = 'latest' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of documents that shouldn't be included in the build. -#unused_docs = [] + +import lmfit +release = lmfit.__version__ # List of directories, relative to source directory, that shouldn't be searched # for source files. |