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.

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

DOC: Display API per module #120

Merged
merged 2 commits into from
Jul 13, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
[![codecov](https://codecov.io/gh/poldracklab/nitransforms/branch/master/graph/badge.svg)](https://codecov.io/gh/poldracklab/nitransforms)
[![doi](https://img.shields.io/badge/doi-10.31219%2Fosf.io%2F8aq7b-blue.svg)](https://doi.org/10.31219/osf.io/8aq7b)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/poldracklab/nitransforms/master?filepath=docs%2Fnotebooks%2F)
[![Docs](https://readthedocs.org/projects/nitransforms/badge/?version=latest)](http://nitransforms.readthedocs.io/en/latest/?badge=latest)

A development repo for [nipy/nibabel#656](https://github.com/nipy/nibabel/pull/656)

Expand All @@ -23,6 +24,6 @@ to apply transforms generated by the most popular neuroimaging packages and libr
(AFNI, FSL, FreeSurfer, ITK, and SPM).
The proposed software is subject to continuous integration tests to check the
compatibility with each supported tool after every change to the code base.
Compatibility between software tools and imaging formats is a necessary bridge
Compatibility between software tools and imaging formats is a necessary bridge
to ensure the reproducibility of results and enable the optimization and evaluation
of current image processing and analysis workflows.
6 changes: 6 additions & 0 deletions docs/_api/base.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
====
Base
====

.. automodule:: nitransforms.base
:members:
39 changes: 39 additions & 0 deletions docs/_api/io.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
===
IO
===

Reading and writing of transform files.

--------
Base I/O
--------
.. automodule:: nitransforms.io.base
:members:

-----------------
Tool Specific I/O
-----------------

^^^^
AFNI
^^^^
.. automodule:: nitransforms.io.afni
:members:

^^^
FSL
^^^
.. automodule:: nitransforms.io.fsl
:members:

^^^
ITK
^^^
.. automodule:: nitransforms.io.itk
:members:

^^^^^^^^^^^^^^
FreeSurfer/LTA
^^^^^^^^^^^^^^
.. automodule:: nitransforms.io.lta
:members:
6 changes: 6 additions & 0 deletions docs/_api/linear.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
=================
Linear Transforms
=================

.. automodule:: nitransforms.linear
:members:
6 changes: 6 additions & 0 deletions docs/_api/manip.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
=============
Manipulations
=============

.. automodule:: nitransforms.manip
:members:
6 changes: 6 additions & 0 deletions docs/_api/nonlinear.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
====================
Nonlinear Transforms
====================

.. automodule:: nitransforms.nonlinear
:members:
6 changes: 6 additions & 0 deletions docs/_api/patched.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
=========================
Patched Nibabel Functions
=========================

.. automodule:: nitransforms.patched
:members:
15 changes: 7 additions & 8 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,11 @@ Library API (application program interface)
Information on specific functions, classes, and methods for developers.

.. toctree::
:glob:
:maxdepth: 1

api/nitransforms.base
api/nitransforms.cli
api/nitransforms.io
api/nitransforms.linear
api/nitransforms.manip
api/nitransforms.nonlinear
api/nitransforms.patched
_api/base
_api/io
_api/linear
_api/manip
_api/nonlinear
_api/patched