-
Notifications
You must be signed in to change notification settings - Fork 46
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
Make it possible to generate a PDF of the documentation #363
Conversation
Reviewer's Guide by SourceryThis pull request introduces the ability to generate a PDF version of the documentation by configuring the LaTeX engine in 'docs/conf.py'. Additionally, it updates the LaTeX math notation in the docstring of the 'compute_overlap' function in 'iodata/overlap.py'. File-Level Changes
Tips
|
Here's the code health analysis summary for commits Analysis Summary
|
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.
Hey @tovrstra - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟡 General issues: 2 issues found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
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.
Cool new feature, thanks.
Thanks for checking Paul! |
This PR is just a side-effect of a small experiment, but still useful to have.
With this change, one can build a PDF of the documentation as follows:
cd docs make latexpdf
(A fairly complete texlive installation is needed for this to work.)
I will YOLO-merge this on Wednesday, July 10 unless reviewed earlier.
Summary by Sourcery
This pull request introduces the capability to generate a PDF version of the documentation using Sphinx. It also includes enhancements to the LaTeX engine configuration and improvements to the LaTeX math rendering in the documentation.
make latexpdf
.compute_overlap
function.