Skip to content

Commit ce12949

Browse files
committed
add intersphinx configuration to docs
1 parent ca8ac6a commit ce12949

File tree

2 files changed

+18
-9
lines changed

2 files changed

+18
-9
lines changed

docs/source/conf.py

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,25 @@
1717
# -- General configuration ---------------------------------------------------
1818
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
1919

20-
extensions = []
20+
# If true, the current module name will be prepended to all description
21+
# unit titles (such as .. function::).
22+
add_module_names = False
23+
24+
extensions = [
25+
"sphinx.ext.intersphinx",
26+
]
2127

2228
# templates_path = ["_templates"]
2329
exclude_patterns = []
2430

31+
intersphinx_mapping = {
32+
"django": (
33+
"https://docs.djangoproject.com/en/5.0/",
34+
"http://docs.djangoproject.com/en/5.0/_objects/",
35+
),
36+
"pymongo": ("https://pymongo.readthedocs.io/en/stable/", None),
37+
"python": ("https://docs.python.org/3/", None),
38+
}
2539

2640
# -- Options for HTML output -------------------------------------------------
2741
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

docs/source/index.rst

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,8 @@
1-
.. django_mongodb documentation master file, created by
2-
sphinx-quickstart on Mon Apr 15 12:38:26 2024.
3-
You can adapt this file completely to your liking, but it should at least
4-
contain the root ``toctree`` directive.
5-
6-
Welcome to django_mongodb's documentation!
7-
==========================================
1+
django-mongodb 5.0.x documentation
2+
==================================
83

94
.. toctree::
10-
:maxdepth: 2
5+
:maxdepth: 1
116
:caption: Contents:
127

138

0 commit comments

Comments
 (0)