Skip to content

Have copies of docs at stable/ and dev/#2968

Merged
lilyminium merged 5 commits intoMDAnalysis:developfrom
lilyminium:stable-docs-dev
Oct 6, 2020
Merged

Have copies of docs at stable/ and dev/#2968
lilyminium merged 5 commits intoMDAnalysis:developfrom
lilyminium:stable-docs-dev

Conversation

@lilyminium
Copy link
Copy Markdown
Member

@lilyminium lilyminium commented Oct 4, 2020

Fixes #2966 (kind of)*

Changes made in this Pull Request:

It will hopefully look like the way docs behave at https://minium.com.au/mdanalysis/ . In short:

This doubling up of docs is based off numpy behaviour, i.e. https://numpy.org/doc/stable/ appears to be the same docs as https://numpy.org/doc/1.19/ . If it's too redundant, we could remove the 1.0.0 and 2.0.0-dev0 entries and just keep stable and dev.

* I manually made the "stable" docs for 1.0.0 because master has moved onto 1.0.1-dev, but the "stable" docs in https://minium.com.au/mdanalysis/ were made by changing the version to "1.0.0" (hence the different date for when they were last built). So https://docs.mdanalysis.org/stable/index.html already exists despite not merging this yet.

Edit: this should go into master as well because it changes the behaviour of the "dev/" URL.

PR Checklist

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

@pep8speaks
Copy link
Copy Markdown

pep8speaks commented Oct 4, 2020

Hello @lilyminium! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

Line 118:80: E501 line too long (87 > 79 characters)
Line 119:80: E501 line too long (92 > 79 characters)

Comment last updated at 2020-10-05 06:38:43 UTC

@lilyminium lilyminium requested a review from orbeckst October 4, 2020 05:27
@codecov
Copy link
Copy Markdown

codecov bot commented Oct 4, 2020

Codecov Report

Merging #2968 into develop will decrease coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #2968      +/-   ##
===========================================
- Coverage    93.05%   93.02%   -0.03%     
===========================================
  Files          186      186              
  Lines        24609    24609              
  Branches      3187     3187              
===========================================
- Hits         22900    22893       -7     
- Misses        1661     1668       +7     
  Partials        48       48              
Impacted Files Coverage Δ
package/MDAnalysis/due.py 66.66% <0.00%> (-8.34%) ⬇️
package/MDAnalysis/coordinates/base.py 94.64% <0.00%> (-0.49%) ⬇️

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 542daa9...2a7f38b. Read the comment docs.

Copy link
Copy Markdown
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.

I agree with your reasoning and decisions – that's the main thing for which I add the 👍 .

From skim-reading the code it was not clear to me if latest in the code refers to "dev" (which is how numpy labels their docs https://numpy.org/doc/). If you could just add a comment (deploy script and update Python script) to add semantics then that would be helpful.

@lilyminium lilyminium merged commit ecaec3f into MDAnalysis:develop Oct 6, 2020
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.

Expose "stable" docs endpoint

4 participants