DOC: readthedocs #327
DOC: readthedocs #327
Conversation
=== Do not change lines below ===
{
"chain": [],
"cmd": "utils/link_issues_CHANGELOG",
"exit": 0,
"extra_inputs": [],
"inputs": [
"CHANGELOG.md"
],
"outputs": [
"CHANGELOG.md"
],
"pwd": "."
}
^^^ Do not change lines above ^^^
Codecov Report
@@ Coverage Diff @@
## master #327 +/- ##
=======================================
Coverage 74.08% 74.08%
=======================================
Files 35 35
Lines 2643 2643
=======================================
Hits 1958 1958
Misses 685 685Continue to review full report at Codecov.
|
…-125-gc350b96e It should generate markdown links as [LINKID][] to follow original markdown (not github flavor) and so pandoc and possibly other tools do not barf
There was a problem hiding this comment.
Looks like a great start, thank you @mgxd !
I have pushed a minor tune up for the changelog.md markdown linking, and otherwise - let's merge and fixup/improve on it. One of the issues I believe remains docker tagging as we have discussed in #315 (comment)
| # The short X.Y version | ||
| version = '' | ||
| # The full version, including alpha/beta/rc tags | ||
| release = '0.5.4' |
There was a problem hiding this comment.
we better automate for this somehow I guess
| can visit `our page on Docker Hub <https://hub.docker.com/r/nipy/heudiconv/tags>`_ | ||
| to view available releases. To pull the latest release, run:: | ||
|
|
||
| $ docker pull nipy/heudiconv:0.5.4 |
There was a problem hiding this comment.
we would be doomed to adjust it for each release, thus forgetting about it etc. We should return/add :latest IMHO.
| DCMDIR=${DCMDIRS[${SLURM_ARRAY_TASK_ID}]} | ||
| echo Submitted directory: ${DCMDIR} | ||
|
|
||
| IMG="/singularity-images/heudiconv-0.5.4-dev.sif" |
There was a problem hiding this comment.
yet another version hardcoded....
utils/link_issues_CHANGELOG
Outdated
| in=CHANGELOG.md | ||
|
|
||
| # Replace them with Markdown references | ||
| sed -i -e 's/(\(#[0-9]\+\))/([\1])/g' "$in" |
There was a problem hiding this comment.
as recently discovered, for "proper" original markdown, so we could convert using pandoc into .rst, should be links such as [#XXX][] not just [#XXX]. I will push a fixup directly into this branch
| OUTPUT=/converted/data/voice | ||
|
|
||
| # find all DICOM directories that start with "voice" | ||
| DCMDIRS=(`find ${DCMROOT} -maxdepth 1 -name voice* -type d`) |
There was a problem hiding this comment.
would it all work in there is a space in the path?
Eventually we should reincarnate ./heudiconv/cli/monitor.py development and absorb all the needed logic in there or in another supplementary helper command.
|
After "tests" pass, I will merge, resolve conflicts in #315, and push there as well |
Closes #256
This is the initial pass at a proper readthedocs page.
Doing this, I came to the realization our docstrings are severely lacking... something to keep in mind going forward. Ideally, I'd like to merge this in for the
0.5.4release and improve on it as we go.