From f866157b74b4dc151db56f35b4e576ae088b717f Mon Sep 17 00:00:00 2001 From: Dan Saunders Date: Mon, 27 Jan 2025 18:57:45 +0000 Subject: [PATCH] initial quartodoc changes --- _quarto.yml | 18 +++++++++++++++++- requirements-dev.txt | 2 ++ 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/_quarto.yml b/_quarto.yml index acb487258..a530bf73d 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -1,6 +1,9 @@ project: type: website +metadata-files: + - _sidebar.yml + website: title: "Axolotl" description: "Fine-tuning" @@ -45,9 +48,22 @@ website: - docs/config.qmd - docs/faq.qmd - format: html: theme: materia css: styles.css toc: true + +quartodoc: + package: axolotl + + sidebar: _sidebar.yml + + sections: + - title: Some functions + desc: Functions to inspect docstrings. + contents: + # the functions being documented in the package. + # you can refer to anything: class methods, modules, etc.. + - get_object + - preview diff --git a/requirements-dev.txt b/requirements-dev.txt index 4b5df167b..451448b25 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -2,3 +2,5 @@ pre-commit black mypy types-requests +quartodoc +quarto-cli