Enabling rtd by adding the required modifications and dependencies #117
Conversation
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
…should work now, need to improve formatting and layout.
…nil, Pyside2 docs say that Python 3.10 is not supported for Pyside2==5.15.2.1 which is the version that is pinned in setup.py but qudi installation docs say it works with Python 3.10 and I myself use Python 3.10. So let's just try Python 3.10
…m pyproject.toml too using the pre-build job
…rnings during the build due to syntax etc but at least the docs render locally. Added several `__init__.py` files to enable autosummary to recurse into submodules. Also some modules were run upon import which broke the build so added `if __name__ == "__main__"` where necessary. For some reason, the widgets submodule actually causes a segfault during the sphinx build which is amazing. I removed the blank `__init__.py` to avoid sphinx recursing into that submodule so the docs can build at least.
Neverhorst
requested changes
Oct 4, 2024
There was a problem hiding this comment.
- Fix merge conflict artifacts
VERSIONfile has been deleted, why?- Do not introduce any
__init__.pyfiles to PEP 420 implicit namespace packages and make sure your IDE/tooling does not do this automatically. This will break thequdinamespace. __main__.pyfiles do not need import guards, i.e.if __name__ == "__main__":- merge
pyproject.tomlfrom currentmain
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
The changes here are just setting up the dependencies for using rtd and making sure it builds correctly.
Motivation and Context
Rtd id the platform that we are using for hosting our project so we make sure it is well established with all the required depndencies.
How Has This Been Tested?
Screenshots (only if appropriate, delete if not):
Types of changes
Checklist:
/docs/changelog.md.(syntax, indentation, mutable default values, etc.).