diff --git a/docs/README.md b/docs/README.md index 54ec9bae..6f848b36 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,2 +1,5 @@ # Hezar Technical Documentation -Coming soon! \ No newline at end of file +This folder is responsible for everything generated or manually authored in the docs. +The docs are built using `Sphinx` and `Furo`. + +The docs are hosted on [https://hezarai.github.io/hezar/](https://hezarai.github.io/hezar/) \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..640c894d --- /dev/null +++ b/docs/index.md @@ -0,0 +1,7 @@ +# Welcome to Hezar's documentation! + +```{toctree} +:maxdepth: 2 + +tutorial/index.md +``` \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index a4c44db5..00000000 --- a/docs/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Welcome to Hezar's documentation! -================================= - -.. toctree:: - :maxdepth: 2 - - tutorial/index.rst