Skip to content

DOC: Self-hosted & multiversion documentation overhaul #243

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

Merged
merged 11 commits into from
Oct 15, 2021
Merged

Conversation

oesteban
Copy link
Member

Following after nipreps/niworkflows#656

@oesteban oesteban requested review from effigies and mgxd October 14, 2021 18:53
@oesteban
Copy link
Member Author

Pending: updating gh-pages accordingly - will do later

@codecov-commenter
Copy link

codecov-commenter commented Oct 14, 2021

Codecov Report

Merging #243 (d524de6) into master (62160d0) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #243   +/-   ##
=======================================
  Coverage   83.06%   83.06%           
=======================================
  Files          25       25           
  Lines        1836     1836           
  Branches      208      208           
=======================================
  Hits         1525     1525           
  Misses        280      280           
  Partials       31       31           
Flag Coverage Δ
travis 83.06% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out 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 62160d0...d524de6. Read the comment docs.

docs/Makefile Outdated
html:
PYTHONPATH=$(PYTHONPATH) $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
PYTHONPATH=$(PYTHONPATH) $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/$(CURBRANCH)
Copy link
Member

Choose a reason for hiding this comment

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

This is going to make it trickier to rerender older versions at need. Or rather, it will create a watershed where we do one thing to render before and another thing to render after. Even if we can't get a single "correct" result now, I would suggest that we leave this rule unchanged and create a new rule like htmlbranch.

Copy link
Member Author

Choose a reason for hiding this comment

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

Since deployment is now decoupled (one needs to actively checkout gh-pages and add/edit contents) I don't think it has much of an effect.

What probably would make sense is to change the name of the variable - OUTDIR would be much more adequate, and the default value would be "html" for consistency with the former make html target. WDYT?

@oesteban oesteban force-pushed the docs/overhaul branch 4 times, most recently from 61c2f16 to 1f81e0e Compare October 15, 2021 09:26
@oesteban oesteban merged commit beed68f into master Oct 15, 2021
@oesteban oesteban deleted the docs/overhaul branch October 15, 2021 09:37
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.

3 participants