This repository has been archived by the owner on Oct 24, 2024. It is now read-only.
Try to fix code links in docs #183
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TomNicholas
added
bug
TomNicholas
changed the title
|
@andersy005 sorry to bother you - do you know why the intersphinx links to the code API in the docs aren't working? |
i think the reason why this syntax is not working
is that we are missing the following entry in the rst files (e.g. .. currentmodule:: datatreethe following seems to be working diff --git a/docs/source/quick-overview.rst b/docs/source/quick-overview.rst
index 5ec2194..fff83b3 100644
--- a/docs/source/quick-overview.rst
+++ b/docs/source/quick-overview.rst
@@ -2,6 +2,9 @@
Quick overview
##############
+
+.. currentmodule:: datatree
+
DataTrees
--------- |
|
Thank you @andersy005 !! |
flamingbear
pushed a commit
to flamingbear/rewritten-datatree
that referenced
this pull request
Jan 19, 2024
* try to fix code links in docs * add currentmodule datatree command to get links to api docs working * add some intersphinx links to xarray API * whatsnew
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Attempt to fix broken code links in docs, specified by
:py:class:`DataTree`Doesn't work yet though, and I don't know why 😕
Tests addedpre-commit run --all-filesNew functions/methods are listed inapi.rstdocs/source/whats-new.rst