-
Notifications
You must be signed in to change notification settings - Fork 118
Add autolink #452
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add autolink #452
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #452 +/- ##
=======================================
Coverage 86.22% 86.22%
=======================================
Files 24 24
Lines 3418 3419 +1
=======================================
+ Hits 2947 2948 +1
Misses 471 471 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See below
doc/conf.py
Outdated
# -- General configuration --------------------------------------------------- | ||
|
||
# more intersphinx | ||
intersphinx_mapping["scipy"] = ("https://docs.scipy.org/doc/scipy/", None) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we just wait for mdolab/sphinx_mdolab_theme#19 to be merged and then pin the newest patch release?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, sorry this was from testing locally, will remove.
The docs look good, so I assume we do not need |
Correct, we typically rely on pip resolving to the latest build (the default behaviour), rather than pinning. We do indeed use those intersphinx links, as confirmed by the build log |
Purpose
Add autolink to docs. I'll add some more type hints in the future.
Expected time until merged
Type of change
Testing
Checklist
flake8
andblack
to make sure the Python code adheres to PEP-8 and is consistently formattedfprettify
or C/C++ code withclang-format
as applicable