From 57ad420ca572aac18496be9e7713371a2049aa24 Mon Sep 17 00:00:00 2001 From: 201st-Luka Date: Fri, 8 Sep 2023 22:51:03 +0200 Subject: [PATCH] docs: creating mkdocs.yml updated requirements-docs.txt --- mkdocs.yml | 21 +++++++++++++++++++-- requirements-docs.txt | 4 +++- 2 files changed, 22 insertions(+), 3 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 7d5f5f7..78d265c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -3,8 +3,7 @@ site_url: https://201st-Luka.github.io/pyclasher/ copyright: Copyright © Copyright (c) 2023 - Present 201st-Luka repo_url: https://github.com/201st-Luka/PyClasher repo_name: 201st-Luka/PyClasher -edit_uri: edit/main/docs/ - +docs_dir: docs nav: - Home: index.md @@ -47,6 +46,24 @@ theme: plugins: - search: lang: en + - git-committers: + repository: 201st-Luka/PyClasher + branch: master + token: !!python/object/apply:os.getenv ["MKDOCS_GIT_COMMITTERS_APIKEY"] + - mkdocstrings: + handlers: + python: + selection: + inherited_members: True + filters: + - "!^_" + rendering: + members_order: source + show_bases: True + show_root_toc_entry: False + group_by_category: True + heading_level: 3 + show_if_no_docstring: True extra: version: diff --git a/requirements-docs.txt b/requirements-docs.txt index 21f876b..7691653 100644 --- a/requirements-docs.txt +++ b/requirements-docs.txt @@ -1,2 +1,4 @@ mkdocs -mkdocs-material \ No newline at end of file +mkdocs-material +mkdocs-git-committers-plugin +mkdocstrings \ No newline at end of file