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

Update documentation #8

Merged
merged 1 commit into from
Jun 24, 2024
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
2 changes: 1 addition & 1 deletion .github/workflows/deploy_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Deploy Sphinx Docs to GitHub Pages
on:
push:
branches:
- dev
- main

jobs:
deploy:
Expand Down
Binary file modified unravel/docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/guide.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/index.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/installation.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/cluster_stats/crop.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/cluster_stats/fdr.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/cluster_stats/index.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/cluster_stats/legend.doctree
Binary file not shown.
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/cluster_stats/prism.doctree
Binary file not shown.
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/cluster_stats/stats.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/cluster_stats/table.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/cluster_stats/toc.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/core/argparse_utils.doctree
Binary file not shown.
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/core/config.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/core/img_io.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/core/img_tools.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/core/toc.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/core/utils.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/image_io/h5_to_tifs.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/image_io/img_to_npy.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/image_io/io_img.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/image_io/io_nii.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/image_io/metadata.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/image_io/nii_hd.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/image_io/nii_info.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/image_io/nii_to_tifs.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/image_io/nii_to_zarr.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/image_io/reorient_nii.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/image_io/tif_to_tifs.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/image_io/toc.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/image_io/zarr_to_nii.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/image_tools/DoG.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/image_tools/avg.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/image_tools/bbox.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/image_tools/extend.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/image_tools/max.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/image_tools/pad.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/image_tools/rb.doctree
Binary file not shown.
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/image_tools/toc.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/region_stats/rstats.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/region_stats/toc.doctree
Binary file not shown.
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/register/reg.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/register/reg_check.doctree
Binary file not shown.
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/register/reg_prep.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/register/toc.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/segment/brain_mask.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/segment/copy_tifs.doctree
Binary file not shown.
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/segment/toc.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/toc.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/unravel_commands.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/utilities/rename.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/utilities/toc.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/voxel_stats/mirror.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/voxel_stats/toc.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/voxel_stats/vstats.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/voxel_stats/z_score.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/warp/to_atlas.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/warp/to_native.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/warp/toc.doctree
Binary file not shown.
Binary file modified unravel/docs/_build/doctrees/unravel/warp/warp.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion unravel/docs/_build/html/_sources/guide.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ unravel_commands runs ./\<repo_root_dir\>/unravel/unravel_commands.py

Its help guide is here: {py:mod}`unravel.unravel_commands`

Commands are defined in the `[project.scripts]` section of the [pyproject.toml](https://github.com/b-heifets/UNRAVEL/blob/dev/pyproject.toml) in the root directory of the UNRAVEL repository (repo).
Commands are defined in the `[project.scripts]` section of the [pyproject.toml](https://github.com/b-heifets/UNRAVEL/blob/main/pyproject.toml) in the root directory of the UNRAVEL repository (repo).

If new commands are added to run new scripts (a.k.a. modules), reinstall the unravel package with pip.

Expand Down
2 changes: 1 addition & 1 deletion unravel/docs/_build/html/guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -653,7 +653,7 @@ <h2>Common commands<a class="headerlink" href="#common-commands" title="Link to
<p class="admonition-title">More info on commands</p>
<p>unravel_commands runs ./&lt;repo_root_dir&gt;/unravel/unravel_commands.py</p>
<p>Its help guide is here: <a class="reference internal" href="unravel/unravel_commands.html#module-unravel.unravel_commands" title="unravel.unravel_commands"><code class="xref py py-mod docutils literal notranslate"><span class="pre">unravel.unravel_commands</span></code></a></p>
<p>Commands are defined in the <code class="docutils literal notranslate"><span class="pre">[project.scripts]</span></code> section of the <a class="reference external" href="https://github.com/b-heifets/UNRAVEL/blob/dev/pyproject.toml">pyproject.toml</a> in the root directory of the UNRAVEL repository (repo).</p>
<p>Commands are defined in the <code class="docutils literal notranslate"><span class="pre">[project.scripts]</span></code> section of the <a class="reference external" href="https://github.com/b-heifets/UNRAVEL/blob/main/pyproject.toml">pyproject.toml</a> in the root directory of the UNRAVEL repository (repo).</p>
<p>If new commands are added to run new scripts (a.k.a. modules), reinstall the unravel package with pip.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>&lt;path<span class="w"> </span>to<span class="w"> </span>the<span class="w"> </span>root<span class="w"> </span>directory<span class="w"> </span>of<span class="w"> </span>the<span class="w"> </span>UNRAVEL<span class="w"> </span>repo&gt;
pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.
Expand Down
Loading