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

Re-enable PDF builds for Read the Docs #3260

Merged
merged 6 commits into from
Aug 10, 2023

Conversation

agriyakhetarpal
Copy link
Member

Description

The SVG images generated by the sphinxext/inheritance_diagram.py extension create multiple PDFs upon LaTeX output with Sphinx's LaTeXBuilder. This PR makes them render on HTML output only, which is in-line with documentation for other projects that display inheritance diagrams for API components.

Closes #3240

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist:

  • No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All tests pass: $ python run-tests.py --all (or $ nox -s tests)
  • The documentation builds: $ python run-tests.py --doctest (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ python run-tests.py --quick (or $ nox -s quick).

Further checks:

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@codecov
Copy link

codecov bot commented Aug 9, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (67dcb1c) 99.71% compared to head (cac25b1) 99.71%.
Report is 2 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #3260   +/-   ##
========================================
  Coverage    99.71%   99.71%           
========================================
  Files          248      248           
  Lines        18861    18861           
========================================
  Hits         18807    18807           
  Misses          54       54           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@Saransh-cpp Saransh-cpp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, looks good, thanks @agriyakhetarpal!

@agriyakhetarpal
Copy link
Member Author

I also added a few CSS improvements and removed rules we did not need (we can inherit them from the theme itself). Ready to merge now

@Saransh-cpp Saransh-cpp merged commit aebe311 into pybamm-team:develop Aug 10, 2023
@agriyakhetarpal agriyakhetarpal deleted the docs-pdf-fix branch August 10, 2023 12:44
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.

Enable pdf build in readthedocs
2 participants