forked from blizzthewolf/SeaCogs
feat(docs): added documentation using mkdocs and readthedocs
This commit is contained in:
parent
47f74d2259
commit
9bd41317c6
6 changed files with 931 additions and 40 deletions
73
mkdocs.yml
Normal file
73
mkdocs.yml
Normal file
|
@ -0,0 +1,73 @@
|
|||
site_name: SeaCogs Documentation
|
||||
site_url: https://seacogs.readthedocs.io
|
||||
repo_name: CoastalCommits
|
||||
repo_url: https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs
|
||||
edit_uri: src/branch/main/.docs
|
||||
copyright: Copyright © 2024, SeaswimmerTheFsh
|
||||
docs_dir: .docs
|
||||
|
||||
site_author: SeaswimmerTheFsh
|
||||
site_description: Documentation for my Red-DiscordBot Cogs.
|
||||
|
||||
nav:
|
||||
- Home: index.md
|
||||
|
||||
plugins:
|
||||
- git-authors
|
||||
- search
|
||||
# - social
|
||||
- git-revision-date-localized:
|
||||
enable_creation_date: true
|
||||
type: timeago
|
||||
- mkdocstrings:
|
||||
default_handler: python
|
||||
handlers:
|
||||
python:
|
||||
paths: [aurora, nerdify]
|
||||
options:
|
||||
docstring_options:
|
||||
ignore_imit_summary: true
|
||||
summary: true
|
||||
show_root_toc_entry: false
|
||||
filters:
|
||||
- "!^___"
|
||||
|
||||
markdown_extensions:
|
||||
- abbr
|
||||
- attr_list
|
||||
- md_in_html
|
||||
- tables
|
||||
- pymdownx.blocks.details
|
||||
- pymdownx.blocks.admonition
|
||||
- pymdownx.saneheaders
|
||||
- pymdownx.magiclink
|
||||
- pymdownx.mark
|
||||
- pymdownx.inlinehilite
|
||||
- pymdownx.snippets
|
||||
- pymdownx.superfences
|
||||
- pymdownx.highlight:
|
||||
anchor_linenums: true
|
||||
line_spans: __span
|
||||
pygments_lang_class: true
|
||||
- pymdownx.emoji:
|
||||
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
||||
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
||||
|
||||
theme:
|
||||
name: material
|
||||
palette:
|
||||
scheme: slate
|
||||
features:
|
||||
- content.code.annotate
|
||||
- content.code.copy
|
||||
- navigation.instant
|
||||
- navigation.tabs
|
||||
- search.suggest
|
||||
- search.highlight
|
||||
- search.share
|
||||
logo: img/logo.png
|
||||
favicon: img/logo.png
|
||||
|
||||
watch:
|
||||
- ./aurora
|
||||
- ./nerdify
|
Loading…
Add table
Add a link
Reference in a new issue