-
Notifications
You must be signed in to change notification settings - Fork 14
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
Adopt the Xanadu Sphinx Theme #73
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code looks 🍾. Haven't tested.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! Attempted to build/test it, but wasn't able to due to the makefile. It seems to be attempting to install requirements.txt
(using pip) when simply running make docs
. This might not be such a good idea, since, at least in my case, it will break my environment. 🤔
Thanks for the reviews, @doctorperceptron and @thisac!
Yeah, it also took a few tries for me to build Jet locally. I think we made a mistake by trying to automate too many things in the Makefile since it introduced some assumptions which don't necessarily hold in each environment. That said, I think we should also acknowledge that
We can usually skip steps (1) and (2) for pure-Python projects but that is not the case here. |
Flyby comment, and I think this is not high priority at all, but you can set up sphinx to mock out the C++ libraries (I think this is what we did with the walrus back when it included C++) to avoid having to build the bindings. The C++ part is still documented via doxygen/exhale/breathe |
Thanks for the comment, @josh146! Does the documented C++ part still include the bindings though? It would be a shame to discard that part of the documentation. |
Ah The Walrus used Cython (not pybind11), so the C++ bindings were read statically by Sphinx... in retrospect not sure if that has implications here. |
Context:
Currently, all Xanadu OSS projects include their own version of the Xanadu Sphinx theme; however, the Xanadu Sphinx Theme repository is now publicly available and is the preferred way to access the Xanadu CSS theme and Sphinx directives.
Description of the Change:
Benefits:
git clone
will run faster.Possible Drawbacks:
None.
Related GitHub Issues:
Depends on XanaduAI/xanadu-sphinx-theme#2.