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

PR documentation builds #42

Closed
josh146 opened this issue Aug 18, 2020 · 5 comments
Closed

PR documentation builds #42

josh146 opened this issue Aug 18, 2020 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@josh146
Copy link
Member

josh146 commented Aug 18, 2020

Currently, if the environment variable MOCK_DOCS is set, the setup.py file will skip the building of the wheels. This is required for ReadTheDocs, where C++ extensions cannot be built.

Unfortunately, ReadTheDocs environment variables are not passed to PRs and forks, so we cannot activate the option to build the docs for PRs. An alternative option would be to simply mock out the C++ extensions in the conf.py file, like we do for The Walrus.

@josh146 josh146 added the documentation Improvements or additions to documentation label Aug 18, 2020
@trbromley
Copy link
Contributor

@josh146, do we still need something in setup.py that allows us to install PennyLane-Lightning without having things like Eigen?

@josh146
Copy link
Member Author

josh146 commented Apr 20, 2021

@trbromley, with the new device, is this issue now closed?

@trbromley
Copy link
Contributor

@josh146 we still have MOCK_DOCS in setup.py so I believe it would still be a blocker for PR docs builds.

Could we remove MOCK_DOCS? 🤔 I'm not sure, the main difference with the new device is removing the Eigen dependency, but we still do load the C++ extensions within the if-statement. Probably the best option would be to follow what is done in the Walrus.

@trbromley
Copy link
Contributor

I believe you can now share env variables with PR builds: readthedocs/readthedocs.org#7182 (comment). Will have a go!

@mlxd
Copy link
Member

mlxd commented Sep 23, 2021

Docs now build in each PR. Closing.

@mlxd mlxd closed this as completed Sep 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants