update docs

Author: Remi-Gau

docs/.gitignore

@@ -0,0 +1 @@
+build

docs/README.md

@@ -3,8 +3,8 @@
 ## Set up virtual environment
 
 ```bash
-virtualenv -p python3 your_repo_name
-source your_repo_name/bin/activate
+virtualenv -p python3.8 env
+source env/bin/activate
 
 pip install -r requirements.txt
 ```

docs/source/conf.py

@@ -17,12 +17,11 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'your repo name'
-copyright = 'you'
-author = 'you'
+project = 'spm_2_bids'
+author = 'Rémi Gau'
 
 # The full version, including alpha/beta/rc tags
-release = 'v0.0.0'
+release = 'v0.1.0'
 
 
 # -- General configuration ---------------------------------------------------
@@ -53,6 +52,8 @@
 # source_suffix = ['.rst', '.md']
 source_suffix = '.rst'
 
+autodoc_member_order = 'bysource'
+
 
 # -- Options for HTML output -------------------------------------------------
 
@@ -64,7 +65,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
 
 # html_logo = '_static/logo.png'
 

docs/source/index.rst

@@ -1,7 +1,7 @@
 .. cpp_bids documentation master file
 
-Welcome to CPP BIDS documentation!
-**********************************
+Welcome to spm_2_bids documentation!
+************************************
 
 .. toctree::
    :maxdepth: 2
@@ -12,11 +12,18 @@ Welcome to CPP BIDS documentation!
 ``spm_2_bids`` only provides names to use but does not actually rename the files.
 
 .. automodule:: src
+   
 .. autofunction:: spm_2_bids
 
 .. automodule:: src.defaults
+
 .. autofunction:: check_cfg
 
+.. autoclass:: Mapping
+    :members:
+
+
+
 
 Indices and tables
 ==================