Migrated the documentation from Jupyter-book to Mkdocs #137
Conversation
feat/mkdocs migration
|
|
||
| # If S0 isn't specified, calculate from baseline | ||
| if S0 is None: | ||
| SIbase=np.mean(SIcurve[1:baselinepts]) |
There was a problem hiding this comment.
Is there a reason you changed this from the original implementation? This is a functional change, not a documentation change.
There was a problem hiding this comment.
Can we swap this out with a modern pyproject.toml file instead?
There was a problem hiding this comment.
Why are we pointing a utility script to a utility script here? Should this be simplified to one utility script in a utilities folder?
There was a problem hiding this comment.
Everything in the guide folder should be consolidated as a readme file or as a development_guide folder in docs that is linked in the readme so that developers can quickly understand how to contribute.
There was a problem hiding this comment.
There are markdown files in the notebooks that should be organized separately. You will need to fix any reference links to these files as well.
There was a problem hiding this comment.
We should probably use a newer version of python here.
Additionally, can you add comments about what the workflow is doing and why?
It should be clear that we first run the notebooks, then mkdocs gh-deploy --force builds the website (and also runs the hook to convert to md)
| - content.action.view | ||
| - content.code.annotate | ||
| - content.code.copy | ||
| # - content.code.select |
There was a problem hiding this comment.
If we aren't using these, we should probably get rid of them.
There was a problem hiding this comment.
Why is there two deployments for the docs here?
Migrated DCE-DSC-MRI_CodeCollection documentation site from Jupyter-book to Mkdocs.