Skip to content

[MRG] DOC fix intersphinx #356

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 1, 2017
Merged

[MRG] DOC fix intersphinx #356

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b8d1adb
DOC fix intersphinx
glemaitre Oct 11, 2017
91cea8f
MAINT update conf.py
glemaitre Nov 1, 2017
cc122a9
Merge remote-tracking branch 'origin/master' into fix_intersphinx
glemaitre Nov 1, 2017
bc011c9
iter
glemaitre Nov 1, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 58 additions & 60 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,31 +14,17 @@

import os
import sys

import sphinx_rtd_theme
from sklearn.externals.six import u

# 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.insert(0, os.path.abspath('.'))

# -- General configuration ---------------------------------------------------

# Try to override the matplotlib configuration as early as possible
try:
import gen_rst
except:
pass
# -- General configuration ------------------------------------------------


# 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.insert(0, os.path.abspath('sphinxext'))

from github_link import make_linkcode_resolve
import sphinx_gallery

# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
# needs_sphinx = '1.0'
Expand All @@ -47,34 +33,30 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx',
'sphinx.ext.todo', 'sphinx.ext.imgmath', 'sphinx.ext.ifconfig',
'sphinx.ext.viewcode', 'sphinx_gallery.gen_gallery',
'sphinx.ext.autosummary', 'numpydoc', 'sphinx.ext.intersphinx',
'sphinx_issues', 'sphinx.ext.linkcode'
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.linkcode',
'sphinx.ext.viewcode',
'numpydoc',
'sphinx_issues',
'sphinx_gallery.gen_gallery',
]

autosummary_generate = True
# this is needed for some reason...
# see https://github.com/numpy/numpydoc/issues/69
numpydoc_show_class_members = False

autodoc_default_flags = ['members', 'inherited-members']
# pngmath / imgmath compatibility layer for different sphinx versions
import sphinx
from distutils.version import LooseVersion
if LooseVersion(sphinx.__version__) < LooseVersion('1.4'):
extensions.append('sphinx.ext.pngmath')
else:
extensions.append('sphinx.ext.imgmath')

sphinx_gallery_conf = {
# path to your examples scripts
'examples_dirs': '../examples',
# path where to save gallery generated examples
'gallery_dirs': 'auto_examples',
# to make references clickable
'doc_module': 'imblearn',
'backreferences_dir': os.path.join('generated'),
'reference_url': {
'imblearn': None,
'sklearn': None,
'matplotlib': None,
'numpy': None,
'scipy': None
}
}
autodoc_default_flags = ['members', 'inherited-members']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand All @@ -88,15 +70,15 @@
# The encoding of source files.
# source_encoding = 'utf-8-sig'

# Generate the plots for the gallery
# Generate the plot for the gallery
plot_gallery = True

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'imbalanced-learn'
copyright = u'2016, G. Lemaitre, F. Nogueira, D. Oliveira, C. Aridas'
project = u('imbalanced-learn')
copyright = u('2016 - 2017, G. Lemaitre, F. Nogueira, D. Oliveira, C. Aridas')

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand All @@ -120,7 +102,7 @@

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
exclude_patterns = ['_build', '_templates']

# The reST default role (used for this markup: `text`) to use for all
# documents.
Expand Down Expand Up @@ -250,8 +232,8 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'imbalanced-learn.tex', u'imbalanced-learn Documentation',
u'G. Lemaitre, F. Nogueira, D. Oliveira, C. Aridas', 'manual'),
('index', 'imbalanced-learn.tex', u('imbalanced-learn Documentation'),
u('G. Lemaitre, F. Nogueira, D. Oliveira, C. Aridas'), 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
Expand All @@ -271,10 +253,29 @@
# Documents to append as an appendix to all manuals.
# latex_appendices = []

# intersphinx configuration
intersphinx_mapping = {
'python': ('https://docs.python.org/{.major}'.format(
sys.version_info), None),
'numpy': ('https://docs.scipy.org/doc/numpy/', None),
'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),
'matplotlib': ('https://matplotlib.org/', None),
'sklearn': ('http://scikit-learn.org/stable', None)
}

# sphinx-gallery configuration
sphinx_gallery_conf = {
'doc_module': 'imblearn',
'backreferences_dir': os.path.join('generated'),
'reference_url': {
'imblearn': None}
}

# -- Options for manual page output ---------------------------------------

# If false, no module index is generated.
# latex_domain_indices = True

# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
Expand All @@ -296,14 +297,14 @@
]


def generate_example_rst(app, what, name, obj, options, lines):
# generate empty examples files, so that we don't get
# inclusion errors if there are no examples for a class / module
examples_path = os.path.join(app.srcdir, "generated",
"%s.examples" % name)
if not os.path.exists(examples_path):
# touch file
open(examples_path, 'w').close()
# def generate_example_rst(app, what, name, obj, options, lines):
# # generate empty examples files, so that we don't get
# # inclusion errors if there are no examples for a class / module
# examples_path = os.path.join(app.srcdir, "generated",
# "%s.examples" % name)
# if not os.path.exists(examples_path):
# # touch file
# open(examples_path, 'w').close()


# Config for sphinx_issues
Expand All @@ -315,7 +316,7 @@ def generate_example_rst(app, what, name, obj, options, lines):

def setup(app):
app.add_javascript('js/copybutton.js')
app.connect('autodoc-process-docstring', generate_example_rst)
# app.connect('autodoc-process-docstring', generate_example_rst)


# Documents to append as an appendix to all manuals.
Expand All @@ -330,9 +331,6 @@ def setup(app):
# If true, do not generate a @detailmenu in the "Top" node's menu.
# texinfo_no_detailmenu = False

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'http://docs.python.org/': None}

# The following is used by sphinx.ext.linkcode to provide links to github
linkcode_resolve = make_linkcode_resolve('imblearn',
u'https://github.com/scikit-learn-contrib/'
Expand Down