Skip to content

Commit

Permalink
Miscelaneous docs update. (#401)
Browse files Browse the repository at this point in the history
- remove sphinxcontrib_github_alt as it is unused since 5c51ceb
- bump used python in a few places.
- and start using intersphinx_registry to simplify managing intersphinx.
  • Loading branch information
Carreau authored Jun 3, 2024
1 parent 9a3595e commit 21155d5
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ python:
build:
os: ubuntu-22.04
tools:
python: "3.11"
python: "3.12"
9 changes: 4 additions & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
import shutil
from pathlib import Path

from intersphinx_registry import get_intersphinx_mapping

from jupyter_core.version import __version__, version_info

# If extensions (or modules to document with autodoc) are in another directory,
Expand All @@ -33,15 +35,14 @@
"myst_parser",
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinxcontrib_github_alt",
"sphinx_autodoc_typehints",
]

try:
import enchant # noqa: F401

extensions += ["sphinxcontrib.spelling"]
except ImportError:
except ModuleNotFoundError:
pass

github_project_url = "https://github.com/jupyter/jupyter_core"
Expand Down Expand Up @@ -294,9 +295,7 @@
# 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 = {"https://docs.python.org/3/": None}
intersphinx_mapping = get_intersphinx_mapping(packages=["python"])


def setup(_):
Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,12 @@ test = [
"pytest-timeout"
]
docs = [
"intersphinx_registry",
"myst-parser",
"sphinxcontrib_github_alt",
"sphinxcontrib_spelling",
"pydata_sphinx_theme",
"sphinx-autodoc-typehints",
"sphinxcontrib_spelling",
"traitlets",
"pydata_sphinx_theme",
]

[project.scripts]
Expand Down

0 comments on commit 21155d5

Please sign in to comment.