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

Install MDAnalysis on ReadTheDocs via pip #3071

Merged
merged 3 commits into from
Dec 15, 2020

Conversation

lilyminium
Copy link
Member

Fixes #3070

Changes made in this Pull Request:

Not sure why setuptools (python package/setup.py install) doesn't work, but, it doesn't.

Sorry @orbeckst 🤦‍♀️

PR Checklist

  • Tests?
  • Docs?
  • CHANGELOG updated?
  • Issue raised/referenced?

@codecov
Copy link

codecov bot commented Dec 10, 2020

Codecov Report

Merging #3071 (c3fc3bc) into develop (2223363) will decrease coverage by 0.06%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #3071      +/-   ##
===========================================
- Coverage    93.17%   93.10%   -0.07%     
===========================================
  Files          171      186      +15     
  Lines        22729    24737    +2008     
  Branches      3216     3216              
===========================================
+ Hits         21177    23031    +1854     
- Misses        1504     1658     +154     
  Partials        48       48              
Impacted Files Coverage Δ
lib/__init__.py 100.00% <0.00%> (ø)
analysis/__init__.py 100.00% <0.00%> (ø)
formats/__init__.py 100.00% <0.00%> (ø)
core/__init__.py 100.00% <0.00%> (ø)
visualization/__init__.py 100.00% <0.00%> (ø)
__init__.py 91.89% <0.00%> (ø)
transformations/__init__.py 100.00% <0.00%> (ø)
coordinates/base.py 95.12% <0.00%> (ø)
datafiles.py 21.42% <0.00%> (ø)
util.py 89.47% <0.00%> (ø)
... and 5 more

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 2223363...f4941da. Read the comment docs.

@cbouy
Copy link
Member

cbouy commented Dec 10, 2020

If I may "intrude", since I'm in the process of using readthedocs for another project: RTD will use whatever you specified in the conda environment.yml file to set up the python env, and ignore both version and requirements parameters under the python parameter in the readthedocs.yml file. So you should probably set the python version in the env.yml file and remove the version line in the readthedocs file if you really want a specific version.

@lilyminium
Copy link
Member Author

Thank you @cbouy!

@lilyminium lilyminium requested a review from orbeckst December 14, 2020 09:04
@lilyminium lilyminium mentioned this pull request Dec 15, 2020
4 tasks
@orbeckst
Copy link
Member

When I looked at the link https://readthedocs.org/projects/mdanalysis/builds/12528298/ I see this confusing message

The project ParmEd doesn't have a valid webhook set up, commits won't trigger new builds for this project. See the project integrations for more information.

Why is ParmEd mentioned here?

image

Copy link
Member

@orbeckst orbeckst left a comment

Choose a reason for hiding this comment

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

It's amazing how much nitty-gritty detail there is to "just make stuff work". Thank you so much for finding it out and actually making it work.

@lilyminium
Copy link
Member Author

Thank you for the reviews @richardjgowers and @orbeckst! So I think that RTD kindly gives you that message if your ParmEd project is not set up with a webhook, even if you're viewing another project -- could you have a look at a different project to see if that's the case? For what it's worth this is how it appears to me:

image

I think this may also only happen if you are logged in and an owner of MDAnalysis and a project called ParmEd at the time.

@orbeckst
Copy link
Member

orbeckst commented Dec 15, 2020 via email

@lilyminium
Copy link
Member Author

Thank you for checking! I did see more than a few of these messages when I was trying to work out ReadTheDocs myself 😅

@lilyminium lilyminium merged commit d4f8e94 into MDAnalysis:develop Dec 15, 2020
@lilyminium lilyminium deleted the pip-install branch December 15, 2020 20:50
lilyminium added a commit to lilyminium/mdanalysis that referenced this pull request Dec 15, 2020
Install via `pip install package/` to build current docs on ReadTheDocs
lilyminium added a commit to lilyminium/mdanalysis that referenced this pull request Dec 21, 2020
Install via `pip install package/` to build current docs on ReadTheDocs
cbouy pushed a commit to cbouy/mdanalysis that referenced this pull request Jan 12, 2021
* Add arbitrary TopologyAttr selection (MDAnalysis#2927)

Fixes MDAnalysis#2925 
Fixes MDAnalysis#2875
Fixes MDAnalysis#3054 

Changes made in this Pull Request:
 - added a class factory to subclass `core.selection.Selection` for each TopologyAttr
 - added tokens to `core.selection.SameSelection`
 - added `FloatRangeSelection` and `BoolSelection`
 - added negatives, scientific notation and "to" delimiter for ranges

* Add ReadTheDocs configuration for PR builds (MDAnalysis#3060)

 - Adds RTD configuration
 - Add `environment.yml` for package installation

* Remove appveyor

* Install MDAnalysis on ReadTheDocs via pip (MDAnalysis#3071)

Install via `pip install package/` to build current docs on ReadTheDocs

* try stringio

* rm metals file

* pin pytest

* pin pytest on gh actions

* Fixes RMSF docstring (Issue MDAnalysis#2806) (MDAnalysis#3033)

Fixes the RMSF docstring's align command and adds transformation to make the results accurate

* MAINT: simplify guessers regex (MDAnalysis#3085)

* the `SYMBOLS` regex in `guessers.py` does not require
any escape sequences because the metacharacters are inactive
in the character class (this includes the range metacharacter
when placed at the start or end of the character class)

* MAINT: char class regex improve

* avoid the overhead of a regex character class
when that character class has only a single character
(i.e., serves no purpose)

* there is only one instance of this in MDA codebase
discovered by my [scraping
code](https://github.com/tylerjereddy/regex-improve)

* for a longer explanation see my similar changes in
NumPy codebase:
numpy/numpy#18083

* Fix syntax warning over comparison of literals using is.

* Quick fix for atommethods to return empty residue group (MDAnalysis#3089)

Returns empty residue group for _get_prev_residues_by_resid and _get_next_residues_by_resid

* Add to authors list.

Co-authored-by: Lily Wang <[email protected]>
Co-authored-by: IAlibay <[email protected]>
Co-authored-by: Tyler Reddy <[email protected]>
Co-authored-by: Lily Wang <[email protected]>
Co-authored-by: Irfan Alibay <[email protected]>
Co-authored-by: Oliver Beckstein <[email protected]>
Co-authored-by: Karthikeyan Singaravelan <[email protected]>
Co-authored-by: Aditya Kamath <[email protected]>
@lilyminium lilyminium mentioned this pull request Jan 24, 2021
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ReadTheDocs isn't building the modified version of docs in pull requests
5 participants