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

Make it possible to generate a PDF of the documentation #363

Merged
merged 2 commits into from
Jul 6, 2024

Conversation

tovrstra
Copy link
Member

@tovrstra tovrstra commented Jul 6, 2024

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.

  • New Features:
    • Added the ability to generate a PDF of the documentation using Sphinx with the command make latexpdf.
  • Enhancements:
    • Updated the LaTeX engine configuration in Sphinx to use 'xelatex' for better PDF generation.
  • Documentation:
    • Improved the LaTeX math rendering in the documentation for the compute_overlap function.

Copy link
Contributor

sourcery-ai bot commented Jul 6, 2024

Reviewer's Guide by Sourcery

This 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

Files Changes
docs/conf.py
iodata/overlap.py
Added support for generating PDF documentation and updated LaTeX math notation in docstrings.

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link

deepsource-io bot commented Jul 6, 2024

Here's the code health analysis summary for commits dafc156..6bc170a. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Shell LogoShell✅ SuccessView Check ↗
DeepSource Python LogoPython✅ SuccessView Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a 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

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

docs/conf.py Show resolved Hide resolved
iodata/overlap.py Outdated Show resolved Hide resolved
Copy link
Member

@PaulWAyers PaulWAyers left a 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.

@tovrstra
Copy link
Member Author

tovrstra commented Jul 6, 2024

Thanks for checking Paul!

@tovrstra tovrstra merged commit d2f91de into theochem:main Jul 6, 2024
12 checks passed
@tovrstra tovrstra deleted the doc-pdf branch July 6, 2024 18:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants