Skip to content

Commit

Permalink
Merged in numpydoc and intersphinx info and banner from vtools docs. …
Browse files Browse the repository at this point in the history
…Haven't got logo working yet
  • Loading branch information
esatel committed Nov 9, 2019
1 parent f50b87f commit 38a7af2
Showing 1 changed file with 44 additions and 12 deletions.
56 changes: 44 additions & 12 deletions docsrc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,31 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode',
'nbsphinx',
'sphinx.ext.mathjax', ]

'matplotlib.sphinxext.mathmpl',
'matplotlib.sphinxext.only_directives',

This comment has been minimized.

Copy link
@dwr-psandhu

dwr-psandhu Nov 11, 2019

Contributor

@esatel This is causing issues with building the docs. This particular one has been removed in matplotlib since 3.0.0 ? matplotlib/sampledoc#1

'matplotlib.sphinxext.plot_directive',
#'matplotlib.sphinxext.ipython_directive',
'sphinx.ext.intersphinx',
'sphinx.ext.autodoc',
'sphinx.ext.doctest','numpydoc']
#'numpydoc']
#'ipython_console_highlighting',
#'inheritance_diagram',
#'numpydoc']

autodoc_member_order = 'alphabetical'

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
# mappings for intersphinx extension
intersphinx_mapping = {'pandas': ('http://pandas.pydata.org/pandas-docs/stable',None),
'python': ('http://docs.python.org/', None),
'xarray' : ('http://xarray.pydata.org/en/stable',None)
}


# The suffix of source filenames.
source_suffix = '.rst'

# The master toctree document.
Expand Down Expand Up @@ -71,29 +86,44 @@

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '**.ipynb_checkpoints']
exclude_patterns = ['*test*']

# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
add_module_names = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
# A list of ignored prefixes for module index sorting.
modindex_common_prefix = ['vtools.','vtools.data.','vtools.functions.','vtools.datastore.']

# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False


# -- Options for HTML output -------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
html_theme = 'default'

# Theme options are theme-specific and customize the look and feel of a
# theme further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = 'dwrsmall.gif'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
Expand All @@ -102,6 +132,8 @@

# -- Options for HTMLHelp output ---------------------------------------

# If false, no module index is generated.
html_domain_indices = ['py-modindex']
# Output file base name for HTML help builder.
htmlhelp_basename = 'vtoolsdoc'

Expand Down

0 comments on commit 38a7af2

Please sign in to comment.