Skip to content

Use intersphinx for documentation links #193

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

Open
oscargus wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Use intersphinx for documentation links #193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,6 @@ sphinx:

python:
install:
- requirements: docs/requirements.txt
- method: pip
path: .
- requirements: docs/requirements.txt
1 change: 1 addition & 0 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ Sphinx
ipykernel
nbsphinx
sphinx_rtd_theme
numpy
37 changes: 13 additions & 24 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
import sys
import os

# import matplotlib
from unittest import mock
from adjustText import __version__

sys.path.insert(0, os.path.abspath("../.."))
# matplotlib.use("Agg")
Expand All @@ -24,15 +23,14 @@
# import sys
# sys.path.insert(0, os.path.abspath('.'))


# -- Project information -----------------------------------------------------

project = "adjustText"
copyright = "2018, Ilya Flyamer"
author = "Ilya Flyamer"

# The short X.Y version
version = "1.0beta"
version = "1.3.0"
# The full version, including alpha/beta/rc tags
# def get_version(path):
# with open(path, "r") as f:
Expand All @@ -43,6 +41,8 @@

# release = get_version("../_version.py")

release = __version__

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

# If your documentation needs a minimal Sphinx version, state it here.
Expand All @@ -56,30 +56,19 @@
"sphinx.ext.autodoc",
"sphinx.ext.viewcode",
"sphinx.ext.githubpages",
"sphinx.ext.intersphinx",
"nbsphinx",
"sphinx.ext.mathjax",
"sphinx.ext.napoleon",
]


MOCK_MODULES = [
"bioframe",
"numpy",
"scipy",
"scipy.spatial",
"scipy.spatial.distance",
"matplotlib",
"matplotlib.pyplot",
"matplotlib.patches",
"matplotlib.patches.FancyArrowPatch",
"matplotlib.path",
"matplotlib.path.get_path_collection_extents",
]

for mod_name in MOCK_MODULES:
sys.modules[mod_name] = mock.Mock()

autodoc_mock_imports = MOCK_MODULES
intersphinx_mapping = {
'python': ('https://docs.python.org/3/', None),
'matplotlib': ('https://matplotlib.org/', None),
'scipy': ('https://docs.scipy.org/doc/scipy/', None),
'numpy': ('https://numpy.org/doc/stable/', None),
'bioframe': ('https://bioframe.readthedocs.io/en/stable/', None),
}

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
Expand All @@ -98,7 +87,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = "en"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down