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] make afq tractometry pipeline page, reorganize usage section #1053

Merged
merged 2 commits into from
Nov 13, 2023
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ ARTIFACTS := $(strip \
distclean: clean
@echo Removing files created by sphinx-build
rm -rf $(BUILDDIR)
rm -f $(SOURCEDIR)/usage/config.rst
rm -f $(SOURCEDIR)/usage/howto/config.rst
rm -rf $(SOURCEDIR)/auto_examples/
$(if $(ARTIFACTS),rm -f $(ARTIFACTS))

Expand Down
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 0 additions & 4 deletions docs/source/explanations/cleaning.rst

This file was deleted.

32 changes: 7 additions & 25 deletions docs/source/explanations/tractometry_pipeline.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,20 @@ AFQ Tractometry Pipeline
.. - |rArr| `Profiling <https://dipy.org/documentation/1.4.0./reference/dipy.stats/#afq-profile>`_
.. - |rArr| `Visualization <http://yeatmanlab.github.io/pyAFQ/autoapi/AFQ/viz/index.html>`_

.. figure:: _static/tract_tractography.png
.. figure:: _static/tract_modeling2.png
:figclass: top-image
:target: tractography.html
:target: modeling.html

:ref:`tractography`
:ref:`modeling`

.. figure:: _static/right_arrow.png
:figclass: right-arrow

.. figure:: _static/tract_modeling.png
.. figure:: _static/tract_tractography.png
:figclass: top-image
:target: modeling.html
:target: tractography.html

:ref:`modeling`
:ref:`tractography`

.. figure:: _static/right_arrow.png
:figclass: right-arrow
Expand All @@ -43,29 +43,11 @@ AFQ Tractometry Pipeline
.. image:: _static/down_arrow.png
:width: 8%

.. figure:: _static/tract_cleaning.png
:figclass: bottom-image
:target: cleaning.html

:ref:`cleaning`

.. figure:: _static/left_arrow.png
:figclass: left-arrow

.. figure:: _static/tract_profiling.png
.. figure:: _static/tract_visualization.png
:figclass: bottom-image
:target: profiling.html

:ref:`profiling`

.. figure:: _static/left_arrow.png
:figclass: left-arrow

.. figure:: _static/tract_visualization.png
:figclass: bottom-image
:target: visualization.html

:ref:`visualization`



4 changes: 0 additions & 4 deletions docs/source/explanations/visualization.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/source/howto/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ software.
:maxdepth: 2

installation_guide
usage
usage/index
contributing
developing/index
getting_help
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
6 changes: 0 additions & 6 deletions docs/source/howto/usage/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,9 @@ Examples of using the API are provided in the :ref:`examples` documentation sect
:maxdepth: 2

data
usage
kwargs
methods
bundledict
config
viz_backend
mask
mapping
scalars
converter
tracking
docker
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/source/reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ Reference Documentation
bundledict
kwargs
methods
tracking
viz_backend
viz_backend
mapping
7 changes: 3 additions & 4 deletions docs/source/reference/kwargs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,10 +99,9 @@ brain_mask_definition: instance from `AFQ.definitions.image`, optional
If None, use B0Image()
Default: None

bundle_info: strings, dict, or BundleDict, optional
List of bundle names to include in segmentation,
or a bundle dictionary (see BundleDict for inspiration),
or a BundleDict. See `Defining Custom Bundle Dictionaries`
bundle_info: dict or BundleDict, optional
A dictionary or BundleDict for use in segmentation.
See `Defining Custom Bundle Dictionaries`
in the `usage` section of pyAFQ's documentation for details.
If None, will get all appropriate bundles for the chosen
segmentation algorithm.
Expand Down
File renamed without changes.
20 changes: 0 additions & 20 deletions docs/source/reference/tracking.rst

This file was deleted.