Repository navigation
Install mcpy on the docs builder - #33
Merged
Merged
Conversation
The API reference switched to autodoc, which imports mcpy, but Read the Docs installs only docs/requirements.txt. Every autodoc directive therefore failed to import and the whole reference built empty, with warnings that nothing gated on (fail_on_warning is off). Adds the package to the docs environment and moves the builder to Python 3.12: the move signatures use PEP 604 unions, which 3.9 cannot even parse. The optional GPU backends stay out; conf.py already mocks torch, mace, nvalchemi, cuequivariance and mpi4py. Verified in a clean env with only sphinx, the RTD theme and mcpy installed: the build now emits no warnings and the reference pages carry their classes.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
#32 switched the API reference to
sphinx.ext.autodoc, which importsmcpy.Read the Docs installs only
docs/requirements.txt(the theme), so on the docsbuilder every autodoc directive fails to import and the whole reference builds
empty.
fail_on_warningis off, so nothing catches it.Reproduced in a clean env with sphinx + the RTD theme and no mcpy:
This installs the package into the docs environment and moves the builder to
Python 3.12 - the move signatures use PEP 604 unions, which the pinned 3.9
cannot parse. The optional GPU backends stay uninstalled;
docs/conf.pyalready mocks torch, mace, nvalchemi, cuequivariance and mpi4py.
After the change, the same clean env builds with no warnings and the reference
pages carry their classes again.