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

MRG: first step DOC versioning #364

Merged
merged 4 commits into from
Mar 22, 2020
Merged

MRG: first step DOC versioning #364

merged 4 commits into from
Mar 22, 2020

Conversation

sappelhoff
Copy link
Member

@sappelhoff sappelhoff commented Mar 21, 2020

I started this PR with high hopes of bringing versioned docs to MNE-BIDS (currently we only have one stable version ... and the "latest" version as hosted in CircleCI artifacts)

... buuut after too many hours of hacking, there are no news apart from these small fixes I now present in this PR 🤷‍♂️

Anyhow, this is what I tried and why it didn't work:

Summary: Neither of the two packages seem very robust ... but they could be used for our purposes ... needs more time investment though and I've had enough for an evening :)

If somebody else wants to give this a shot, please do it!

EDIT: An alternative is of course to do it like in MNE-Python and manually upload the docs for each release: https://github.com/mne-tools/mne-tools.github.io ... and then adding some html/css templates to link to those

Edit2: Another alternative would be a move to https://readthedocs.org/, but that would mean giving up our current system, relying on GitHub Pages.

Merge checklist

Maintainer, please confirm the following before merging:

  • All comments resolved
  • This is not your own PR
  • All CIs are happy
  • PR title starts with [MRG]
  • whats_new.rst is updated
  • PR description includes phrase "closes <#issue-number>"
  • Commit history does not contain any merge commits

@sappelhoff sappelhoff changed the title DOC versioning (not yet) MRG: DOC versioning (not yet) Mar 21, 2020
@jasmainak
Copy link
Member

I think given that we are a young and light package with very few dependencies, we can ask people to update to the latest version periodically. I know that readthedocs supports versioning but I like the template that we have :)

@codecov-io
Copy link

codecov-io commented Mar 22, 2020

Codecov Report

Merging #364 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #364   +/-   ##
=======================================
  Coverage   95.16%   95.16%           
=======================================
  Files          11       11           
  Lines        1364     1364           
=======================================
  Hits         1298     1298           
  Misses         66       66
Impacted Files Coverage Δ
mne_bids/write.py 97.52% <ø> (ø) ⬆️

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 baff3f7...bb84e2f. Read the comment docs.

@sappelhoff
Copy link
Member Author

sappelhoff commented Mar 22, 2020

@jasmainak I added a small navigation dropdown (copied from MNE-Python), which I think is an enhancement :-)

This is how it looks like in the rendered preview: https://1721-89170358-gh.circle-artifacts.com/0/html/index.html

image

@sappelhoff
Copy link
Member Author

Travis error on macos is very uninformative : An error occurred while generating the build script.

@agramfort
Copy link
Member

agramfort commented Mar 22, 2020 via email

@sappelhoff sappelhoff added this to the 0.4 milestone Mar 22, 2020
@sappelhoff sappelhoff changed the title MRG: DOC versioning (not yet) MRG: first step DOC versioning Mar 22, 2020
@sappelhoff sappelhoff mentioned this pull request Mar 22, 2020
@jasmainak
Copy link
Member

cool ! let me know when to merge

@sappelhoff
Copy link
Member Author

cool ! let me know when to merge

ready now! :-)

@jasmainak jasmainak merged commit c916594 into mne-tools:master Mar 22, 2020
@jasmainak
Copy link
Member

Thanks @sappelhoff !

@sappelhoff sappelhoff deleted the doc branch March 22, 2020 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants