Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Documentation #59

Open
robbisg opened this issue Feb 9, 2020 · 1 comment
Open

Documentation #59

robbisg opened this issue Feb 9, 2020 · 1 comment
Labels
documentation thread Collections of issues

Comments

@robbisg
Copy link
Owner

robbisg commented Feb 9, 2020

Little guide to how compile + create documentation.
@robbisg robbisg pinned this issue Feb 9, 2020
@robbisg
Copy link
Owner Author

robbisg commented Feb 9, 2020 •
edited
Loading

Preliminary operations:

  • pip install sphinx
  • pip install rhinotype
  • Add to environment.yaml and requirements.txt
  • Understand how to add sphinx-gallery

General

  • Describe folder structure and BIDS
  • Describe pymvpa Dataset
  • Describe an example of analysis with iterators
  • Describe results folder and data structure

Modules

  • Describe Transformers
  • Describe Analysis

Functions

  • save must be documented for Analyzers

Examples

  • Add example gallery
  • [ ]

@robbisg robbisg added the thread Collections of issues label May 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation thread Collections of issues
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@robbisg