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.

Sign up for GitHub

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

Jump to bottom

Automate document version to match plasmapy.__version__ #781

Merged
merged 5 commits into from
Apr 9, 2020
Merged

Automate document version to match plasmapy.__version__ #781

merged 5 commits into from
Apr 9, 2020

Conversation

rocco8773
Copy link
Member

@rocco8773 rocco8773 commented Apr 8, 2020 •
edited
Loading

Updated definition of release and version in docs/conf.py, so the documentation version will be automatically updated with the package version plasmapy.__version__.

Note:

  1. I rely on the import of plasmapy.__version__ opposed to using pkg_resources.get_distribution(), because I want to rely on defining mechanics of plasmapy.__version__. By doing this, I also get a version number for the scenario where the package is not pip installed.
  2. If plasmapy.__version__ is not able to be generated, then it defaults to 'unknown'. However, the version attribute for Sphinx must follow a semantic versioning style, so version = release = '' is set if plasmapy.__version__ == 'unknown'.

Closes #775

@rocco8773 rocco8773 added docs PlasmaPy Docs at http://docs.plasmapy.org feature request Issues requesting a new feature or enhancement labels Apr 8, 2020
@rocco8773 rocco8773 self-assigned this Apr 8, 2020
@pep8speaks
Copy link

pep8speaks commented Apr 8, 2020 •
edited
Loading

Hello @rocco8773! Thanks for updating your pull request.

Line 78:1: E402 module level import not at top of file

Comment last updated at 2020-04-09 21:00:45 UTC

@codecov
Copy link

codecov bot commented Apr 8, 2020 •
edited
Loading

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #781   +/-   ##
=======================================
  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% <0.00%> (ø)

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 7972832...7af5320. Read the comment docs.

@rocco8773 rocco8773 merged commit b8d40a0 into PlasmaPy:master Apr 9, 2020
@rocco8773 rocco8773 deleted the automate-doc-version branch June 4, 2020 19:57
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

@namurphy namurphy namurphy approved these changes

Assignees

@rocco8773 rocco8773

Labels
docs PlasmaPy Docs at http://docs.plasmapy.org feature request Issues requesting a new feature or enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Fix definition of version and release in docs conf.py
4 participants
@rocco8773 @pep8speaks @namurphy @StanczakDominik