Skip to content

Conversation

ewu63
Copy link
Collaborator

@ewu63 ewu63 commented Aug 17, 2025

Purpose

Add autolink to docs. I'll add some more type hints in the future.

Expected time until merged

Type of change

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (non-backwards-compatible fix or feature)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Documentation update
  • Maintenance update
  • Other (please describe)

Testing

Checklist

  • I have run flake8 and black to make sure the Python code adheres to PEP-8 and is consistently formatted
  • I have formatted the Fortran code with fprettify or C/C++ code with clang-format as applicable
  • I have run unit and regression tests which pass locally with my changes
  • I have added new tests that prove my fix is effective or that my feature works
  • I have added necessary documentation

@ewu63 ewu63 requested a review from a team as a code owner August 17, 2025 19:31
@ewu63 ewu63 requested review from kanekosh and sanjan98 August 17, 2025 19:31
Copy link

codecov bot commented Aug 17, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.22%. Comparing base (b687be3) to head (4ca68d8).
⚠️ Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Collaborator

@marcomangano marcomangano left a 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)
Copy link
Collaborator

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?

Copy link
Collaborator Author

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.

@marcomangano
Copy link
Collaborator

The docs look good, so I assume we do not need intersphinx for numpy and scipy and/or pin the latest version of sphinx_mdolab_theme, right?

@ewu63
Copy link
Collaborator Author

ewu63 commented Aug 20, 2025

The docs look good, so I assume we do not need intersphinx for numpy and scipy and/or pin the latest version of sphinx_mdolab_theme, right?

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

@marcomangano marcomangano merged commit b9ff2c3 into main Aug 20, 2025
18 checks passed
@marcomangano marcomangano deleted the add-autolink branch August 20, 2025 17:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants