Skip to content

Commit

Permalink
docs: creating mkdocs.yml
Browse files Browse the repository at this point in the history
updated requirements-docs.txt
  • Loading branch information
201st-Luka committed Sep 8, 2023
1 parent e0fb9a1 commit 57ad420
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 3 deletions.
21 changes: 19 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down
4 changes: 3 additions & 1 deletion requirements-docs.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
mkdocs
mkdocs-material
mkdocs-material
mkdocs-git-committers-plugin
mkdocstrings

0 comments on commit 57ad420

Please sign in to comment.