From aa6cf8eab95bf0defdf6cf204bdf236824d39be7 Mon Sep 17 00:00:00 2001 From: Paddy Roddy Date: Fri, 8 Sep 2023 19:41:04 +0100 Subject: [PATCH] Add docs config --- .pre-commit-config.yaml | 1 + docs/api.md | 24 +++++++++++++++++++++++- mkdocs.yml | 4 ++-- 3 files changed, 26 insertions(+), 3 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index d5a73f1..2382085 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -15,6 +15,7 @@ repos: rev: v3.0.3 hooks: - id: prettier + exclude: docs/api.md - repo: https://github.com/pre-commit/pre-commit-hooks rev: v4.4.0 hooks: diff --git a/docs/api.md b/docs/api.md index 225a714..a7ab71e 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,3 +1,25 @@ # API Documentation -::: heracles.catalog.FitsCatalog +::: heracles + options: + # general + allow_inspection: false + show_bases: false + show_source: false + # headings + show_category_heading: true + show_object_full_path: false + show_root_toc_entry: false + # members + filters: ["!^__?"] + inherited_members: true + show_submodules: true + # docstrings + docstring_options: + ignore_init_summary: true + docstring_section_style: spacy + merge_init_into_class: true + show_if_no_docstring: true + # signatures + line_length: 80 + show_signature_annotations: true diff --git a/mkdocs.yml b/mkdocs.yml index e29b576..d729daa 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,12 +6,12 @@ nav: theme: name: material palette: - # Palette toggle for dark mode + # palette toggle for dark mode - scheme: slate toggle: icon: material/brightness-4 name: Switch to light mode - # Palette toggle for light mode + # palette toggle for light mode - scheme: default toggle: icon: material/brightness-7