Skip to content

Conversation

@wiheto
Copy link
Collaborator

@wiheto wiheto commented Nov 26, 2019

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.

Copy link
Member

@oesteban oesteban left a comment

Choose a reason for hiding this comment

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

Warning, treated as error:
/root/project/docs/contributing_tutorials/adding_a_new_template.rst:document isn't included in any toctree

Sphinx is asking you to link your new documents from some higher-level document, either indexing it in a toctree or using the include environment.

I'd suggest to add links to the toctree here - https://github.com/templateflow/python-client/blob/bac4e2a7bd5fc33aee1adac5f54b2f3e644ae89b/docs/index.rst#contents

oesteban added a commit that referenced this pull request Jan 29, 2020
@oesteban
Copy link
Member

Merged via a2a4bf8

@oesteban oesteban closed this Jan 29, 2020
@oesteban
Copy link
Member

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

@oesteban oesteban deleted the docs branch January 29, 2020 08:32
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