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

Fix building of documentaiton using tox #780

Merged
merged 5 commits into from
Apr 9, 2020

Conversation

rocco8773
Copy link
Member

@rocco8773 rocco8773 commented Apr 7, 2020

This is an attempt to fix the documentation build errors via tox as seen on CircleCI (see #778)

  1. Removed duplicate docstrings for ParticleTracker.kinetic_energy_history. Docstrings were defined both in the method definition and class level docstrings.
  2. Added dependency sphinx <= 2.4.4, since sphinx-automodapi is currently failing with sphinx v3.0.0.

Closes #778

@rocco8773 rocco8773 added bug Issues describing unexpected behavior or defects. Remember: a bug is a sign of a missing test! docs PlasmaPy Docs at http://docs.plasmapy.org labels Apr 7, 2020
@rocco8773 rocco8773 self-assigned this Apr 7, 2020
@codecov
Copy link

codecov bot commented Apr 7, 2020

Codecov Report

Merging #780 into master will not change coverage by %.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #780   +/-   ##
=======================================
  Coverage   96.00%   96.00%           
=======================================
  Files          55       55           
  Lines        4981     4981           
=======================================
  Hits         4782     4782           
  Misses        199      199           
Impacted Files Coverage Δ
plasmapy/simulation/particletracker.py 98.30% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8ade13c...86c19e7. Read the comment docs.

@rocco8773 rocco8773 merged commit 7972832 into PlasmaPy:master Apr 9, 2020
@namurphy namurphy added bugfix Pull requests that fix a bug. Remember: a bug is a sign of a missing test! and removed bug Issues describing unexpected behavior or defects. Remember: a bug is a sign of a missing test! labels May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bugfix Pull requests that fix a bug. Remember: a bug is a sign of a missing test! docs PlasmaPy Docs at http://docs.plasmapy.org
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CircleCI docs build failing on master
2 participants