-
Notifications
You must be signed in to change notification settings - Fork 28
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
Conversation
Pending: updating |
Codecov Report
@@ 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
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
docs/Makefile
Outdated
html: | ||
PYTHONPATH=$(PYTHONPATH) $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html | ||
PYTHONPATH=$(PYTHONPATH) $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/$(CURBRANCH) |
There was a problem hiding this comment.
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
.
There was a problem hiding this comment.
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?
61c2f16
to
1f81e0e
Compare
1f81e0e
to
48977bf
Compare
Following after nipreps/niworkflows#656