Have copies of docs at stable/ and dev/#2968
Conversation
|
Hello @lilyminium! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:
Comment last updated at 2020-10-05 06:38:43 UTC |
Codecov Report
@@ 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
Continue to review full report at Codecov.
|
orbeckst
left a comment
There was a problem hiding this comment.
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.
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
numpybehaviour, 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 the1.0.0and2.0.0-dev0entries and just keepstableanddev.* I manually made the "stable" docs for 1.0.0 because
masterhas 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