Reference function from within jupyter notebook #455
Replies: 1 comment
-
Hello! First, I think you shouldn't need to prepend the path with Then, to auto-reference an other object, the syntax is |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
I am using the mkdocs-jupyter extension.
In my Jupyter notebook
nb.ipynb
, I would like to put a reference to a docstring inapi_reference.md
.In
api_reference.md
I defined some items using the Autodoc syntax, something like:Let's say, I have a markdown cell in
nb.ipynb
, how can I referencesrc.my_package.main.func_1
?Simply putting
[src.my_package.main.func_1]
doesn't seem to work.Beta Was this translation helpful? Give feedback.
All reactions