search

templateflow / python-client

A python client to query TemplateFlow via pyBIDS
https://templateflow.org/python-client/
Apache License 2.0
8 stars 12 forks source link

Contributing documentation #32

Closed wiheto closed 4 years ago

wiheto commented 4 years ago

So here is the first draft of the documentation. Could definitely still be improved in many places. I also have not modified the toctree which is why circleci is failing.

4 files have been submitted.

  1. Is a prerequisites tutorial regarding everything that needs to be set up installed.
  2. Is about adding a new template space
  3. Is about uploading other files. This could be improved in some places (e.g. making the python code a script packaged with some part of the repo datalad_osf), adding information about atlas metainformation. It is currently unclear to me how/where the exact commit gets updated. So if someone submits a PR to tpl-test, how does that commit number get updated in templateflow/templateflow.
  4. A quick overview of the common BIDS names (as deviations) found in templateflow.

Can spend some time making it more readable, I guess the first step is to make sure the content covers everything and is correct.

oesteban commented 4 years ago

Merged via a2a4bf8136bec5ac55a5640c2c8482b07904562a

oesteban commented 4 years ago

And the new docs are up! - https://templateflow.github.io/python-client/