Skip to content

Commit a4ccefc

Browse files
committed
add some docs
1 parent 997388b commit a4ccefc

File tree

3 files changed

+63
-0
lines changed

3 files changed

+63
-0
lines changed

docs/babs.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
babs package
2+
===========
3+
4+
Core Module
5+
----------
6+
7+
.. automodule:: babs.babs
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
11+
12+
Utils Module
13+
-----------
14+
15+
.. automodule:: babs.utils
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
CLI Module
21+
---------
22+
23+
.. automodule:: babs.cli
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:

docs/index.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
Welcome to BABS's documentation!
2+
================================
3+
4+
BABS (BIDS App Build System) is a tool for building and managing BIDS Apps.
5+
6+
.. toctree::
7+
:maxdepth: 2
8+
:caption: Contents:
9+
10+
readme
11+
modules
12+
contributing
13+
authors
14+
history
15+
16+
Installation
17+
------------
18+
19+
To install BABS, run:
20+
21+
.. code-block:: console
22+
23+
$ pip install babs
24+
25+
Indices and tables
26+
==================
27+
28+
* :ref:`genindex`
29+
* :ref:`modindex`
30+
* :ref:`search`

docs/modules.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
API Documentation
2+
================
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
7+
babs

0 commit comments

Comments
 (0)