Add intersphinx and autolink :) #73
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
lwasser
reviewed
Oct 24, 2024
| @@ -1,4 +1,9 @@ | |||
|
|
|||
| .navbar-header-items .navbar-header-items__center { | |||
| margin-left: 2em !important; | |||
| } | |||
There was a problem hiding this comment.
@sneakers-the-rat this is awesome. If you remember, let's try to add these changes to our theme as well! i think they are valuable in all of our books!!
|
i didn't know about the code autolink. We should make all of these extensions default in all of our books 🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I personally really appreciate it when documentation will link to the api docs for the things they reference, and i feel like it might be especially helpful for our students to be able to refer to the docs at any point if they need to :).
Just added intersphinx mappings, went through and searched for mentions of functions from other packages ( i'm sure i missed a bunch ), and i also added the codeautolink extension to automatically add links within the code examples with a very subtle underline like this:
Also edited some references to close-and-they-actually-should-be-named-that-but-nonexistent modules like
pandas.apply()andpandas.datetimejust so the students don't go lookin for em :)