Refactor docs

hezarai · Aug 19, 2023 · 4917b2b · 4917b2b
1 parent 655f1e2
commit 4917b2b
Show file tree

Hide file tree

Showing 10 changed files with 38 additions and 16 deletions.
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
@@ -10,9 +10,10 @@ jobs:
       - uses: actions/setup-python@v3
       - name: Install dependencies
         run: |
-          pip install sphinx sphinx_rtd_theme furo
+          pip install sphinx sphinx_rtd_theme furo myst-parser
       - name: Sphinx build
         run: |
+          sphinx-apidoc -H Hezar -o docs/source hezar/
           sphinx-build docs _build
 
       - name: Deploy

diff --git a/docs/conf.py b/docs/conf.py
@@ -17,6 +17,7 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",
     "sphinx.ext.mathjax",
+    "myst_parser",
     "sphinx.ext.viewcode",
     "sphinx.ext.autosummary",
     "sphinx.ext.napoleon",
@@ -25,7 +26,21 @@
 templates_path = ['_templates']
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
-
+myst_enable_extensions = [
+    "amsmath",
+    "attrs_inline",
+    "colon_fence",
+    "deflist",
+    "dollarmath",
+    "fieldlist",
+    "html_admonition",
+    "html_image",
+    "replacements",
+    "smartquotes",
+    "strikethrough",
+    "substitution",
+    "tasklist",
+]
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,20 +1,7 @@
-.. Hezar documentation master file, created by
-   sphinx-quickstart on Thu Aug 17 20:32:47 2023.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Welcome to Hezar's documentation!
 =================================
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
-
-
-
-Indices and tables
-==================
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   tutorial/index.rst
diff --git a/docs/tutorial/datasets.md b/docs/tutorial/datasets.md
@@ -0,0 +1 @@
+# Datasets
diff --git a/docs/tutorial/index.rst b/docs/tutorial/index.rst
@@ -0,0 +1,11 @@
+Tutorial
+========
+.. toctree::
+   :maxdepth: 2
+
+   overview.md
+   installation.md
+   models.md
+   datasets.md
+   training.md
+   preprocessors.md
diff --git a/docs/tutorial/installation.md b/docs/tutorial/installation.md
@@ -0,0 +1 @@
+# Installation
diff --git a/docs/tutorial/models.md b/docs/tutorial/models.md
@@ -0,0 +1 @@
+# Models 
diff --git a/docs/tutorial/overview.md b/docs/tutorial/overview.md
@@ -0,0 +1,3 @@
+# Overview
+
+
diff --git a/docs/tutorial/preprocessors.md b/docs/tutorial/preprocessors.md
@@ -0,0 +1 @@
+# Preprocessors
diff --git a/docs/tutorial/training.md b/docs/tutorial/training.md
@@ -0,0 +1 @@
+# Training models