add more docs

bagustris · Mar 7, 2024 · d9b98f5 · d9b98f5
1 parent f6a300e
commit d9b98f5
Show file tree

Hide file tree

Showing 9 changed files with 34 additions and 845 deletions.
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,4 +1,6 @@
 ipython_genutils==0.1.0
 sphinx==4.0.2
 nbsphinx==0.8.6
-sphinx-material
+sphinx-material
+sphinx-rtd-theme
+myst-parser
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -32,7 +32,9 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
     # 'nbsphinx',           # to embedd ipynb files
-    'sphinx.ext.mathjax' # to enable latex
+    'sphinx.ext.mathjax', # to enable latex
+    'sphinx_rtd_theme',
+    'myst_parser',        # to enable markdown
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -54,10 +56,17 @@
 # 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']
 
 # suffix for source files
-source_suffix = '.rst'
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.txt': 'restructuredtext',
+    '.md': 'markdown',
+}
+
+# headed anchors until h3
+myst_heading_anchors = 3
 
 # The master toctree document.
 master_doc = 'index'

diff --git a/docs/source/hello_world.rst b/docs/source/hello_world.rst
diff --git a/docs/source/how_to.rst b/docs/source/how_to.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -5,7 +5,7 @@
 
 Welcome to nkululeko's documentation!
 =====================================
-This documentation contains installation, usage, INI file format, and examples of Nkululeko, Machine Learning Speaker Characteristics. The program is intended for novice people interested in speaker characteristics detection (e.g., emotion, age, and gender) without proficient in (Python) programming language.  Main features of Nkululeko are:
+This documentation contains installation, usage, INI file format, and tutorials of Nkululeko, Machine Learning Speaker Characteristics. The program is intended for novice people interested in speaker characteristics detection (e.g., emotion, age, and gender) without proficient in (Python) programming language.  Main features of Nkululeko are:
 
 1. Finding good combinations of acoustic features and models (classifier or regressor) for speaker characteristics detection,
 2. Characteristics of the database, such as distibution of gender, age, emotion, duration, data size, and so on with their visualization,
@@ -25,22 +25,29 @@ The examples only covers some important features of Nkululeko. For more details,
    :maxdepth: 2
    :caption: USAGE
 
-   usage
+   usage.md
 
 .. toctree::
    :maxdepth: 2
-   :caption: INI file 
+   :caption: INI File 
 
-   ini
+   ini_file.md
 
 .. toctree::
    :maxdepth: 2
-   :caption: Examples
+   :caption: Tutorials
 
    how_to
-   hello_world
+   hello_world_aud.md
+   hello_world_csv.md
    comparing
+
 
+.. toctree::
+   :maxdepth: 1
+   :caption: Function Reference
+
+   calfem_reference
 
 Indices and tables
 ==================