diff --git a/.github/workflows/build-docs.yaml b/.github/workflows/build-docs.yaml index 21e14e57b..c61bf28ae 100644 --- a/.github/workflows/build-docs.yaml +++ b/.github/workflows/build-docs.yaml @@ -30,7 +30,7 @@ jobs: python-version: "3.10" - name: Install dependencies - run: pip install -e '.[all, docs]' + run: pip install uv && uv pip install --system '.[all, docs]' # setup quarto for rendering example/tutorial nbs - uses: quarto-dev/quarto-actions/setup@v2 @@ -69,7 +69,7 @@ jobs: await github.rest.actions.createWorkflowDispatch({ owner: 'nixtla', repo: 'docs', - workflow_id: 'mintlify-action-preview.yml', + workflow_id: 'preview.yml', ref: 'main', }); @@ -82,6 +82,6 @@ jobs: await github.rest.actions.createWorkflowDispatch({ owner: 'nixtla', repo: 'docs', - workflow_id: 'mintlify-action.yml', + workflow_id: 'production.yml', ref: 'main', }); diff --git a/docs/mintlify/docs.json b/docs/mintlify/docs.json new file mode 100644 index 000000000..45ba0727a --- /dev/null +++ b/docs/mintlify/docs.json @@ -0,0 +1,135 @@ +{ + "$schema": "https://mintlify.com/docs.json", + "theme": "mint", + "name": "Nixtla", + "colors": { + "primary": "#0E0E0E", + "light": "#FAFAFA", + "dark": "#0E0E0E" + }, + "favicon": "/favicon.svg", + "navigation": { + "groups": [ + { + "group": " ", + "pages": [ + "index.html" + ] + }, + { + "group": "Getting Started", + "pages": [ + "docs/getting-started/installation.html", + "docs/getting-started/getting_started_short.html", + "docs/getting-started/getting_started_complete.html", + "docs/getting-started/getting_started_complete_polars.html" + ] + }, + { + "group": "Tutorials", + "pages": [ + "docs/tutorials/anomalydetection.html", + "docs/tutorials/conformalprediction.html", + "docs/tutorials/crossvalidation.html", + "docs/tutorials/electricityloadforecasting.html", + "docs/tutorials/electricitypeakforecasting.html", + "docs/tutorials/garch_tutorial.html", + "docs/tutorials/intermittentdata.html", + "docs/tutorials/mlflow.html", + "docs/tutorials/multipleseasonalities.html", + "docs/tutorials/statisticalneuralmethods.html", + "docs/tutorials/uncertaintyintervals.html" + ] + }, + { + "group": "How to Guides", + "pages": [ + "docs/how-to-guides/automatic_forecasting.html", + "docs/how-to-guides/exogenous.html", + "docs/how-to-guides/generating_features.html", + "docs/how-to-guides/sklearn_models.html", + "docs/how-to-guides/numba_cache.html" + ] + }, + { + "group": "Distributed", + "pages": [ + "docs/distributed/dask.html", + "docs/distributed/ray.html", + "docs/distributed/spark.html" + ] + }, + { + "group": "Experiments", + "pages": [ + "docs/experiments/amazonstatsforecast.html", + "docs/experiments/autoarima_vs_prophet.html", + "docs/experiments/ets_ray_m5.html", + "docs/experiments/prophet_spark_m5.html" + ] + }, + { + "group": "Model References", + "pages": [ + "docs/models/adida.html", + "docs/models/arch.html", + "docs/models/arima.html", + "docs/models/autoarima.html", + "docs/models/autoces.html", + "docs/models/autoets.html", + "docs/models/autoregressive.html", + "docs/models/autotheta.html", + "docs/models/crostonclassic.html", + "docs/models/crostonoptimized.html", + "docs/models/crostonsba.html", + "docs/models/dynamicoptimizedtheta.html", + "docs/models/dynamicstandardtheta.html", + "docs/models/garch.html", + "docs/models/holt.html", + "docs/models/holtwinters.html", + "docs/models/imapa.html", + "docs/models/mfles.html", + "docs/models/multipleseasonaltrend.html", + "docs/models/optimizedtheta.html", + "docs/models/seasonalexponentialsmoothing.html", + "docs/models/seasonalexponentialsmoothingoptimized.html", + "docs/models/simpleexponentialoptimized.html", + "docs/models/simpleexponentialsmoothing.html", + "docs/models/standardtheta.html", + "docs/models/tsb.html" + ] + }, + { + "group": "API Reference", + "pages": [ + "src/core/core.html", + "src/core/distributed.fugue.html", + "src/core/models.html", + "src/core/models_intro.html", + "src/feature_engineering.html" + ] + }, + { + "group": "Contributing", + "pages": [ + "docs/contribute/contribute.html", + "docs/contribute/docs.html", + "docs/contribute/issue-labels.html", + "docs/contribute/issues.html", + "docs/contribute/step-by-step.html", + "docs/contribute/techstack.html" + ] + } + ] + }, + "logo": { + "light": "/light.png", + "dark": "/dark.png" + }, + "navbar": { + "primary": { + "type": "github", + "href": "https://github.com/Nixtla/nixtla" + } + } +} \ No newline at end of file diff --git a/docs/mintlify/mint.json b/docs/mintlify/mint.json deleted file mode 100644 index c07a63547..000000000 --- a/docs/mintlify/mint.json +++ /dev/null @@ -1,138 +0,0 @@ -{ - "$schema": "https://mintlify.com/schema.json", - "name": "Nixtla", - "logo": { - "light": "/light.png", - "dark": "/dark.png" - }, - "favicon": "/favicon.svg", - "colors": { - "primary": "#0E0E0E", - "light": "#FAFAFA", - "dark": "#0E0E0E", - "anchors": { - "from": "#2AD0CA", - "to": "#0E00F8" - } - }, - "topbarCtaButton": { - "type": "github", - "url": "https://github.com/Nixtla/nixtla" - }, - "topAnchor": { - "name": "StatsForecast", - "icon": "bolt" - }, - "navigation": [ - { - "group": "", - "pages": [ - "index.html" - ] - }, - { - "group": "Getting Started", - "pages": [ - "docs/getting-started/installation.html", - "docs/getting-started/getting_started_short.html", - "docs/getting-started/getting_started_complete.html", - "docs/getting-started/getting_started_complete_polars.html" - ] - }, - { - "group": "Tutorials", - "pages": [ - "docs/tutorials/anomalydetection.html", - "docs/tutorials/conformalprediction.html", - "docs/tutorials/crossvalidation.html", - "docs/tutorials/electricityloadforecasting.html", - "docs/tutorials/electricitypeakforecasting.html", - "docs/tutorials/garch_tutorial.html", - "docs/tutorials/intermittentdata.html", - "docs/tutorials/mlflow.html", - "docs/tutorials/multipleseasonalities.html", - "docs/tutorials/statisticalneuralmethods.html", - "docs/tutorials/uncertaintyintervals.html" - ] - }, - { - "group": "How to Guides", - "pages": [ - "docs/how-to-guides/automatic_forecasting.html", - "docs/how-to-guides/exogenous.html", - "docs/how-to-guides/generating_features.html", - "docs/how-to-guides/sklearn_models.html", - "docs/how-to-guides/numba_cache.html" - ] - }, - { - "group": "Distributed", - "pages": [ - "docs/distributed/dask.html", - "docs/distributed/ray.html", - "docs/distributed/spark.html" - ] - }, - { - "group": "Experiments", - "pages": [ - "docs/experiments/amazonstatsforecast.html", - "docs/experiments/autoarima_vs_prophet.html", - "docs/experiments/ets_ray_m5.html", - "docs/experiments/prophet_spark_m5.html" - ] - }, - { - "group": "Model References", - "pages": [ - "docs/models/adida.html", - "docs/models/arch.html", - "docs/models/arima.html", - "docs/models/autoarima.html", - "docs/models/autoces.html", - "docs/models/autoets.html", - "docs/models/autoregressive.html", - "docs/models/autotheta.html", - "docs/models/crostonclassic.html", - "docs/models/crostonoptimized.html", - "docs/models/crostonsba.html", - "docs/models/dynamicoptimizedtheta.html", - "docs/models/dynamicstandardtheta.html", - "docs/models/garch.html", - "docs/models/holt.html", - "docs/models/holtwinters.html", - "docs/models/imapa.html", - "docs/models/mfles.html", - "docs/models/multipleseasonaltrend.html", - "docs/models/optimizedtheta.html", - "docs/models/seasonalexponentialsmoothing.html", - "docs/models/seasonalexponentialsmoothingoptimized.html", - "docs/models/simpleexponentialoptimized.html", - "docs/models/simpleexponentialsmoothing.html", - "docs/models/standardtheta.html", - "docs/models/tsb.html" - ] - }, - { - "group": "API Reference", - "pages": [ - "src/core/core.html", - "src/core/distributed.fugue.html", - "src/core/models.html", - "src/core/models_intro.html", - "src/feature_engineering.html" - ] - }, - { - "group": "Contributing", - "pages": [ - "docs/contribute/contribute.html", - "docs/contribute/docs.html", - "docs/contribute/issue-labels.html", - "docs/contribute/issues.html", - "docs/contribute/step-by-step.html", - "docs/contribute/techstack.html" - ] - } - ] -} \ No newline at end of file