-
Notifications
You must be signed in to change notification settings - Fork 13
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
Update documentation for v0.7
release
#266
Conversation
Should there be a vectorisation example notebook to explain how broadcasting works? |
For the The |
The Accelerator, Error, Track Methods and Utils doc pages are empty 🤔 In Particles, only the docs for |
I think in |
So it turns out that rendering the docs does not work for files that have relative imports in them. We will have to keep that in mind for the future. For now, I returned all imports back to absolute imports (except for those in |
On a side note, what was the reason to switch to relative import? I think we started with having the full imports anyway. |
I thought we started having the relative ones 😄. In general, I would argue that relative imports are better Python style. The issue seems to be that Sphinx doesn't like them. The annoying bit there is that this error happens mostly silently. I only noticed it because parts of the docs were missing (specifically those from files that had at least one relative import in them). The only real clue that this was happening was in the build logs on readthedocs, where if you scroll through and look closely, you can find warnings like this one
And then of course the fix is to make all imports absolute, e.g. from cheetah.themoduleyouwant import thethingyouwant |
…/cheetah into 256-update-documentation-for-v07
Description
Updates the documentation to match Cheetah
v0.7
for its release. A particular focus is put on the new broadcasting semantics, making sure that the entire documentation accurately reflects the latter.Motivation and Context
Addresses #256.
Types of changes
Checklist
flake8
(required).pytest
tests pass (required).pytest
on a machine with a CUDA GPU and made sure all tests pass (required).Note: We are using a maximum length of 88 characters per line.