Doc enhancements (#101)

Author: deven367

.github/workflows/build-docs.yaml

@@ -15,13 +15,18 @@ jobs:
 
       - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
         with:
-          python-version: '3.10'
+          python-version: "3.10"
 
-      - name: Build docs
-        run: |
-          pip install . lazydocs
-          lazydocs .coreforecast
-          python docs/to_mdx.py
+      - name: Install dependencies
+        run: pip install -e '.[dev]' lazydocs pyyaml
+
+      # setup quarto for rendering example/tutorial nbs
+      - uses: quarto-dev/quarto-actions/setup@v2
+        with:
+          version: 1.4.515
+
+      - name: Build Docs
+        run: make all_docs
 
       - name: Deploy
         if: github.event_name == 'push'

.gitignore

@@ -40,3 +40,17 @@ build
 
 # jupyter
 .ipynb_checkpoints
+
+
+# ignore files created in the docs folder
+docs/*.md
+docs/**/*.mdx
+
+docs-scripts
+docs/mintlify/examples
+
+nbs/_extensions
+.quarto
+
+*.png
+.DS_Store

Makefile

@@ -0,0 +1,30 @@
+load_docs_scripts:
+# 	load processing scripts
+	if [ ! -d "docs-scripts" ] ; then \
+		git clone -b scripts https://github.com/Nixtla/docs.git docs-scripts --single-branch; \
+	fi
+
+api_docs:
+	lazydocs .coreforecast --no-watermark
+	python docs/to_mdx.py
+
+examples_docs:
+	mkdir -p nbs/_extensions
+	cp -r docs-scripts/mintlify/ nbs/_extensions/mintlify
+	quarto render nbs --output-dir ../docs/mintlify/
+
+format_docs:
+	# replace _docs with docs
+	sed -i -e 's/_docs/docs/g' ./docs-scripts/docs-final-formatting.bash
+	bash ./docs-scripts/docs-final-formatting.bash
+
+
+preview_docs:
+	cd docs/mintlify && mintlify dev
+
+clean:
+	rm -f docs/*.md
+	find docs/mintlify -name "*.mdx" -exec rm -f {} +
+
+
+all_docs: load_docs_scripts api_docs examples_docs format_docs

nbs/_quarto.yml

@@ -0,0 +1,5 @@
+format:
+  mintlify-md:
+    code-fold: true
+project:
+  type: mintlify

pyproject.toml

@@ -25,7 +25,7 @@ dev = ["pandas", "pre-commit", "pytest"]
 
 [project.urls]
 homepage = "https://nixtla.github.io/coreforecast"
-documentation = "https://nixtla.github.io/coreforecast"
+documentation = "https://nixtlaverse.nixtla.io/coreforecast"
 repository = "https://github.com/Nixtla/coreforecast"
 
 [build-system]