Skip to content

Commit fc60093

Browse files
authored
docs: fix doc linking (#6)
1 parent a212e55 commit fc60093

File tree

4 files changed

+5
-3
lines changed

4 files changed

+5
-3
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,3 +106,4 @@ ENV/
106106

107107
mpl_arrow/_version.py
108108
src/mpl_arrow/_version.py
109+
docs/api

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![Python Version](https://img.shields.io/pypi/pyversions/mpl-arrow.svg?color=green)](https://python.org)
44
[![CI](https://github.com/mpl-extensions/mpl-arrow/actions/workflows/ci.yml/badge.svg)](https://github.com/mpl-extensions/mpl-arrow/actions/workflows/ci.yml)
55
[![codecov](https://codecov.io/gh/mpl-extensions/mpl-arrow/branch/main/graph/badge.svg)](https://codecov.io/gh/mpl-extensions/mpl-arrow)
6-
[![Documentation Status](https://readthedocs.org/projects/mpl-arrow/badge/?version=stable)](https://mpl-arrow.readthedocs.io/en/stable/?badge=stable)
6+
[![Documentation Status](https://readthedocs.org/projects/mpl-arrow/badge/?version=stable)](https://mpl-arrow.readthedocs.io/en/stable/)
77

88
# mpl-arrow
99
A simpler way to draw nice arrows in matplotlib

docs/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
"--no-toc",
4343
"--templatedir _templates",
4444
"--separate",
45-
"../mpl_arrow/",
45+
"../src/mpl_arrow/",
4646
# excluded modules
4747
# nothing here for cookiecutter
4848
]
@@ -63,6 +63,7 @@
6363
"sphinx.ext.autodoc",
6464
"sphinx.ext.inheritance_diagram",
6565
"autoapi.sphinx",
66+
"sphinx.ext.intersphinx",
6667
]
6768

6869
# API settings

docs/index.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"Easily plot nice-looking arrows with matplotlib\n",
1111
"\n",
1212
"\n",
13-
"`mpl-arrow` provides functions for drawing arrows (vectors) between two points in data space. The `arrow` function mimics the api of `~matplotlib.pyplot.arrow` but with defaults that allow the arrow to render nicely. Additionally `arrow_absolute` and `vector` provide alternative function signatures.\n",
13+
"`mpl-arrow` provides functions for drawing arrows (vectors) between two points in data space. The {func}`.arrow` function mimics the api of {func}`matplotlib.pyplot.arrow` but with defaults that allow the arrow to render nicely. Additionally {func}`.arrow_absolute` and {func}`.vector` provide alternative function signatures.\n",
1414
"\n",
1515
"\n",
1616
"Key aspects of the functions are that they all:\n",

0 commit comments

Comments
 (0)