STYLE: Make documentation module consistent with Sphinx conventions

Make the documentation module consistent with Sphinx conventions: - Rename the module to `docs`. - Host the configuration file and index file in `docs/sources`. Chang the makefile `SOURCEDIR` variable accordingly.
SlicerDMRI · Oct 22, 2023 · 96a67dc · 96a67dc
1 parent 6bd4a22
commit 96a67dc
Show file tree

Hide file tree

Showing 20 changed files with 3 additions and 3 deletions.
diff --git a/doc/Makefile → docs/Makefile b/doc/Makefile → docs/Makefile
@@ -5,7 +5,7 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = doc
+SOURCEDIR     = source
 BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".

diff --git a/doc/bundles.md → docs/bundles.md b/doc/bundles.md → docs/bundles.md
diff --git a/doc/make.bat → docs/make.bat b/doc/make.bat → docs/make.bat
diff --git a/doc/conf.py → docs/source/conf.py b/doc/conf.py → docs/source/conf.py
@@ -27,7 +27,7 @@
 # Load the release info into a dict by explicit execution
 info = {}
 with open(os.path.abspath(os.path.join(
-        os.path.dirname(__file__), "..", "setup.py")), "r") as f:
+        os.path.dirname(__file__), "../..", "setup.py")), "r") as f:
     for line in f:
         if line.startswith(name_setup_str):
             project = (

diff --git a/doc/index.rst → docs/source/index.rst b/doc/index.rst → docs/source/index.rst
diff --git a/...ect-specific-tractography-parcellation.md → ...ect-specific-tractography-parcellation.md b/...ect-specific-tractography-parcellation.md → ...ect-specific-tractography-parcellation.md
diff --git a/doc/tutorial-pics/fig_csv_clusters.png → docs/tutorial-pics/fig_csv_clusters.png b/doc/tutorial-pics/fig_csv_clusters.png → docs/tutorial-pics/fig_csv_clusters.png
diff --git a/doc/tutorial-pics/fig_csv_tracts.png → docs/tutorial-pics/fig_csv_tracts.png b/doc/tutorial-pics/fig_csv_tracts.png → docs/tutorial-pics/fig_csv_tracts.png
diff --git a/doc/tutorial-pics/fig_ini_fiber_clusters.jpg → .../tutorial-pics/fig_ini_fiber_clusters.jpg b/doc/tutorial-pics/fig_ini_fiber_clusters.jpg → .../tutorial-pics/fig_ini_fiber_clusters.jpg
diff --git a/doc/tutorial-pics/fig_qc_ana_tracts.png → docs/tutorial-pics/fig_qc_ana_tracts.png b/doc/tutorial-pics/fig_qc_ana_tracts.png → docs/tutorial-pics/fig_qc_ana_tracts.png
diff --git a/doc/tutorial-pics/fig_qc_ini_clusters.png → docs/tutorial-pics/fig_qc_ini_clusters.png b/doc/tutorial-pics/fig_qc_ini_clusters.png → docs/tutorial-pics/fig_qc_ini_clusters.png
diff --git a/doc/tutorial-pics/fig_qc_input_overlap.jpg → docs/tutorial-pics/fig_qc_input_overlap.jpg b/doc/tutorial-pics/fig_qc_input_overlap.jpg → docs/tutorial-pics/fig_qc_input_overlap.jpg
diff --git a/doc/tutorial-pics/fig_qc_input_tract.png → docs/tutorial-pics/fig_qc_input_tract.png b/doc/tutorial-pics/fig_qc_input_tract.png → docs/tutorial-pics/fig_qc_input_tract.png
diff --git a/doc/tutorial-pics/fig_qc_outlier_removed.png → .../tutorial-pics/fig_qc_outlier_removed.png b/doc/tutorial-pics/fig_qc_outlier_removed.png → .../tutorial-pics/fig_qc_outlier_removed.png
diff --git a/doc/tutorial-pics/fig_qc_reg_overlap.jpg → docs/tutorial-pics/fig_qc_reg_overlap.jpg b/doc/tutorial-pics/fig_qc_reg_overlap.jpg → docs/tutorial-pics/fig_qc_reg_overlap.jpg
diff --git a/doc/tutorial-pics/fig_separated_clusters.png → .../tutorial-pics/fig_separated_clusters.png b/doc/tutorial-pics/fig_separated_clusters.png → .../tutorial-pics/fig_separated_clusters.png
diff --git a/doc/tutorial-pics/fig_terminal_env.png → docs/tutorial-pics/fig_terminal_env.png b/doc/tutorial-pics/fig_terminal_env.png → docs/tutorial-pics/fig_terminal_env.png
diff --git a/doc/tutorial-pics/fig_tract_reg_folder.png → docs/tutorial-pics/fig_tract_reg_folder.png b/doc/tutorial-pics/fig_tract_reg_folder.png → docs/tutorial-pics/fig_tract_reg_folder.png
diff --git a/doc/tutorial-pics/fig_tutorial_data.png → docs/tutorial-pics/fig_tutorial_data.png b/doc/tutorial-pics/fig_tutorial_data.png → docs/tutorial-pics/fig_tutorial_data.png
diff --git a/setup.py b/setup.py
@@ -35,7 +35,7 @@
     version='0.3.0',
     author='Fan Zhang and Lauren O\'Donnell',
     author_email='[email protected]',
-    packages=find_packages(exclude=["doc"]),
+    packages=find_packages(exclude=["docs"]),
     license='LICENSE.txt',
     description='Processing of whole-brain streamline tractography.',
     long_description=open('README.md').read(),