chore: docs
This commit is contained in:
7
docs/abc/game.md
Normal file
7
docs/abc/game.md
Normal file
@ -0,0 +1,7 @@
|
||||
# Game
|
||||
|
||||
::: vollerei.abc.launcher.game.GameABC
|
||||
handler: python
|
||||
options:
|
||||
show_root_heading: true
|
||||
show_source: true
|
||||
9
docs/common/functions.md
Normal file
9
docs/common/functions.md
Normal file
@ -0,0 +1,9 @@
|
||||
# Common function for all games
|
||||
|
||||
Since you should use the specific implementation for the target game instead, these functions may not be correctly documented.
|
||||
|
||||
::: vollerei.common.functions
|
||||
handler: python
|
||||
options:
|
||||
show_root_heading: true
|
||||
show_source: true
|
||||
7
docs/genshin/game.md
Normal file
7
docs/genshin/game.md
Normal file
@ -0,0 +1,7 @@
|
||||
# Game
|
||||
|
||||
::: vollerei.genshin.Game
|
||||
handler: python
|
||||
options:
|
||||
show_root_heading: true
|
||||
show_source: true
|
||||
7
docs/hsr/game.md
Normal file
7
docs/hsr/game.md
Normal file
@ -0,0 +1,7 @@
|
||||
# Game
|
||||
|
||||
::: vollerei.hsr.Game
|
||||
handler: python
|
||||
options:
|
||||
show_root_heading: true
|
||||
show_source: true
|
||||
7
docs/hsr/patcher.md
Normal file
7
docs/hsr/patcher.md
Normal file
@ -0,0 +1,7 @@
|
||||
# Patcher
|
||||
|
||||
::: vollerei.hsr.Patcher
|
||||
handler: python
|
||||
options:
|
||||
show_root_heading: true
|
||||
show_source: true
|
||||
8
docs/hsr/patchtype.md
Normal file
8
docs/hsr/patchtype.md
Normal file
@ -0,0 +1,8 @@
|
||||
# PatchType
|
||||
|
||||
::: vollerei.hsr.PatchType
|
||||
handler: python
|
||||
options:
|
||||
show_root_heading: true
|
||||
show_source: true
|
||||
|
||||
17
docs/index.md
Normal file
17
docs/index.md
Normal file
@ -0,0 +1,17 @@
|
||||
# Welcome to MkDocs
|
||||
|
||||
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
|
||||
|
||||
## Commands
|
||||
|
||||
* `mkdocs new [dir-name]` - Create a new project.
|
||||
* `mkdocs serve` - Start the live-reloading docs server.
|
||||
* `mkdocs build` - Build the documentation site.
|
||||
* `mkdocs -h` - Print help message and exit.
|
||||
|
||||
## Project layout
|
||||
|
||||
mkdocs.yml # The configuration file.
|
||||
docs/
|
||||
index.md # The documentation homepage.
|
||||
... # Other markdown pages, images and other files.
|
||||
7
docs/zzz/game.md
Normal file
7
docs/zzz/game.md
Normal file
@ -0,0 +1,7 @@
|
||||
# Game
|
||||
|
||||
::: vollerei.zzz.Game
|
||||
handler: python
|
||||
options:
|
||||
show_root_heading: true
|
||||
show_source: true
|
||||
Reference in New Issue
Block a user