diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index f8741493..46ef4b27 100644 --- 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 index e5516a63..2041e3cc 100644 --- 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 index 0ba69ea1..a4c44db5 100644 --- 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 new file mode 100644 index 00000000..157ea3aa --- /dev/null +++ b/docs/tutorial/datasets.md @@ -0,0 +1 @@ +# Datasets diff --git a/docs/tutorial/index.rst b/docs/tutorial/index.rst new file mode 100644 index 00000000..1f44b7fd --- /dev/null +++ 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 \ No newline at end of file diff --git a/docs/tutorial/installation.md b/docs/tutorial/installation.md new file mode 100644 index 00000000..25267fe2 --- /dev/null +++ b/docs/tutorial/installation.md @@ -0,0 +1 @@ +# Installation diff --git a/docs/tutorial/models.md b/docs/tutorial/models.md new file mode 100644 index 00000000..57cf0623 --- /dev/null +++ b/docs/tutorial/models.md @@ -0,0 +1 @@ +# Models \ No newline at end of file diff --git a/docs/tutorial/overview.md b/docs/tutorial/overview.md new file mode 100644 index 00000000..94692d74 --- /dev/null +++ b/docs/tutorial/overview.md @@ -0,0 +1,3 @@ +# Overview + + diff --git a/docs/tutorial/preprocessors.md b/docs/tutorial/preprocessors.md new file mode 100644 index 00000000..9692eb9f --- /dev/null +++ b/docs/tutorial/preprocessors.md @@ -0,0 +1 @@ +# Preprocessors \ No newline at end of file diff --git a/docs/tutorial/training.md b/docs/tutorial/training.md new file mode 100644 index 00000000..8135168c --- /dev/null +++ b/docs/tutorial/training.md @@ -0,0 +1 @@ +# Training models \ No newline at end of file