rename

Author: aghaeifar

README.md

@@ -10,7 +10,7 @@
 
 <p align="center">
 <a href="https://github.com/aghaeifar/SpinWalk">
-<img src="doc/img/logo.png" alt="MC/DC logo" width="160" height="180">
+<img src="docs/img/logo.png" alt="MC/DC logo" width="160" height="180">
 </a>
 </p>
 
@@ -23,7 +23,7 @@ This program is designed to simulate the behavior of spins under a specific MR s
 
 Here are example plots obtained from SpinWalk where show BOLD sensitivity as a function of vessel size for Gradient Echo (GRE) and Spin Echo (SE) seqeuences.
 
-![](./doc/img/gre_se.jpg)
+![](./docs/img/gre_se.jpg)
 
 Some [literature](#Literature) are provided as reference to get a better feeling of what are intended to get from this kind of simulations.
 

doc/img/M1XYZ1_memory_layout.png renamed to docs/img/M1XYZ1_memory_layout.png

@@ -0,0 +1,78 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath(".."))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "SpinWalk"
+author = "Ali Aghaeifar"
+
+# The full version, including alpha/beta/rc tags
+release = "0.1.0"
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "nbsphinx",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = [
+    "_build",
+    "**.ipynb_checkpoints",
+]
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "furo"
+
+# 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_logo = "_static/logo.png"
+
+html_theme_options = {
+    "sidebar_hide_name": True,
+}
+
+# Specify master doc so build at read the docs won't fail
+master_doc = "index"
+
+# Syntax highlighting
+pygments_style = "stata-light"
+pygments_dark_style = "stata-dark"
+
+autodoc_default_options = {
+    "imported-members": True,
+}