Visitar URL original
Update Read the Docs configuration and add `graphviz` dependency by namurphy · Pull Request #1840 · PlasmaPy/PlasmaPy · GitHub
Skip to content

Update Read the Docs configuration and add graphviz dependency - #1840

Merged
namurphy merged 12 commits into
PlasmaPy:mainfrom
namurphy:add-graphviz-dependency
Dec 20, 2022
Merged

Update Read the Docs configuration and add graphviz dependency#1840
namurphy merged 12 commits into
PlasmaPy:mainfrom
namurphy:add-graphviz-dependency

Conversation

@namurphy

@namurphy namurphy commented Dec 20, 2022

Copy link
Copy Markdown
Member

@namurphy namurphy added the no changelog entry needed For PRs that should not have a changelog entry label Dec 20, 2022
@github-actions

github-actions Bot commented Dec 20, 2022

Copy link
Copy Markdown

Thank you for contributing to PlasmaPy! The project's future depends deeply on contributors like you, so we deeply appreciate it! 🌱 The following checklist will be used by the code reviewer to help guide the code review process.

  • Overall
    • Does the PR do what it intends to do?
    • Except for very minor changes, is a changelog entry included and consistent with the changelog guide?
    • Are the continuous integration checks passing? (Most linter problems can be automagically fixed by commenting on this PR with pre-commit.ci autofix.)
  • Code
    • Is new/updated code understandable and consistent with the coding guide?
    • Are there ways to greatly simplify the implementation?
    • Are there any large functions that should be split up into shorter functions?
  • Tests
    • Are tests added/updated as required, and consistent with the testing guide?
    • Are the tests understandable?
    • Do the tests cover all important cases?
  • Docs
    • Are docs added/updated as required, and consistent with the doc guide?
    • Are the docs understandable?
    • Do the docs show up correctly in the preview, including Jupyter notebooks?

@codecov

codecov Bot commented Dec 20, 2022 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

Base: 98.33% // Head: 98.33% // No change to project coverage 👍

Coverage data is based on head (e64c9db) compared to base (c61da87).
Patch has no changes to coverable lines.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #1840   +/-   ##
=======================================
  Coverage   98.33%   98.33%           
=======================================
  Files          95       95           
  Lines        8343     8343           
=======================================
  Hits         8204     8204           
  Misses        139      139

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@namurphy namurphy added the priority: high Issues & PRs with significant urgency and importance that should be addressed soon label Dec 20, 2022
@namurphy
namurphy marked this pull request as ready for review December 20, 2022 16:25
@namurphy
namurphy requested a review from a team as a code owner December 20, 2022 16:25
@namurphy
namurphy requested review from StanczakDominik and removed request for a team December 20, 2022 16:25
@namurphy

namurphy commented Dec 20, 2022 •
edited
Loading

Copy link
Copy Markdown
Member Author

namurphy
namurphy commented Dec 20, 2022
View reviewed changes
Comment thread .readthedocs.yml
Comment on lines +22 to +23
sphinx:
fail_on_warning: true

@namurphy namurphy Dec 20, 2022

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This adds the -W --keep-going flags to the doc build, which are used in the build_docs tox environment.

@namurphy
namurphy enabled auto-merge (squash) December 20, 2022 16:45
@namurphy
namurphy merged commit fedcdad into PlasmaPy:main Dec 20, 2022
@namurphy
namurphy deleted the add-graphviz-dependency branch December 21, 2022 17:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@StanczakDominik StanczakDominik StanczakDominik approved these changes

Assignees

No one assigned

Labels

no changelog entry needed For PRs that should not have a changelog entry priority: high Issues & PRs with significant urgency and importance that should be addressed soon

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Documentation bug with inheritance diagrams

2 participants

@namurphy @StanczakDominik