Skip to content
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

Intersphinx + Fix Attribute/Property Docs #64

Merged
merged 9 commits into from
Jun 14, 2024

Conversation

shanemcq18
Copy link
Member

A few improvements to the documentation.

  • Added intersphinx for python, numpy, scipy, matplotlib, and scikit-learn. Now the documentation has direct links to, e.g., scipy.linalg.lstsq() where relevant.
  • Changed docs/templates/class.rst so that the properties are not listed with autodoc, but with autoattribute. This prevents jupyter book (really sphinx) from complaining that there's a link to a nonexistant page for every single class property. The documentation should now compile without any warnings.

No changes to the source code.

@shanemcq18 shanemcq18 added the documentation Changes to or problems with the package documenation label Jun 13, 2024
@shanemcq18 shanemcq18 merged commit d1e9701 into Willcox-Research-Group:main Jun 14, 2024
13 checks passed
@shanemcq18 shanemcq18 deleted the intersphinx branch June 14, 2024 16:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes to or problems with the package documenation
Development

Successfully merging this pull request may close these issues.

1 participant