Skip to content

Commit

Permalink
Reorg docs a bit.
Browse files Browse the repository at this point in the history
  • Loading branch information
tsalo committed Jan 31, 2024
1 parent 32225c9 commit ac9450d
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 23 deletions.
14 changes: 14 additions & 0 deletions docs/cli.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
======================
Command Line Interface
======================

.. code-block:: bash
cubids --help
This will print the instructions for using the command line interface in your command line.

.. argparse::
:ref: cubids.cli._get_parser
:prog: cubids
:func: _get_parser
5 changes: 4 additions & 1 deletion docs/glossary.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
.. include:: links.rst

Glossary
========

.. glossary::

Key Group
Expand Down Expand Up @@ -32,6 +35,6 @@


References
==========
----------

.. footbibliography::
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ Contents
:maxdepth: 2

about
usage
installation
usage
cli
example
examples
../CONTRIBUTING
Expand Down
26 changes: 5 additions & 21 deletions docs/usage.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
==================
Commands & Actions
==================
========================
General Usage Guidelines
========================

Before we implement a ``CuBIDS`` workflow, let's define the terminology
and take a look at some of the commands available in the software.
Expand Down Expand Up @@ -226,25 +226,9 @@ Applying these changes we would see:
:header-rows: 1


Command line tools
------------------

With that brief introduction done, we can introduce the full gamut of ``CuBIDS`` command line tools:

.. code-block:: bash
cubids --help
This will print the instructions for using the command line interface in your command line.

.. argparse::
:ref: cubids.cli._get_parser
:prog: cubids
:func: _get_parser


Customizable configuration
---------------------------
--------------------------

``CuBIDS`` also features an optional, customizable, MRI image type-specific configuration file.
This file can be passed as an argument to ``cubids group`` and ``cubids apply``
using the ``--config`` flag and allows users to customize grouping settings based on
Expand Down

0 comments on commit ac9450d

Please sign in to comment.