docs(docs): adding initial mkdocs build
This commit is contained in:
parent
5d0d8ef312
commit
67c8456a22
4 changed files with 77 additions and 0 deletions
3
szurubooru-client-docs/build.sh
Executable file
3
szurubooru-client-docs/build.sh
Executable file
|
|
@ -0,0 +1,3 @@
|
|||
#!/bin/bash
|
||||
|
||||
maturin develop -F python -m ../szurubooru-client/Cargo.toml && mkdocs build
|
||||
22
szurubooru-client-docs/docs/index.md
Normal file
22
szurubooru-client-docs/docs/index.md
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
# 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.
|
||||
|
||||
## Autodoc example
|
||||
|
||||
::: szurubooru_client.SzurubooruSyncClient
|
||||
:docstring:
|
||||
14
szurubooru-client-docs/mkdocs.yml
Normal file
14
szurubooru-client-docs/mkdocs.yml
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
site_name: szurubooru_client
|
||||
|
||||
theme:
|
||||
name: "material"
|
||||
|
||||
plugins:
|
||||
- search
|
||||
- mkdocstrings:
|
||||
default_handler: python
|
||||
handlers:
|
||||
python:
|
||||
options:
|
||||
allow_inspection: true
|
||||
load_external_modules: true
|
||||
38
szurubooru-client-docs/requirements.txt
Normal file
38
szurubooru-client-docs/requirements.txt
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
babel==2.16.0
|
||||
certifi==2024.7.4
|
||||
charset-normalizer==3.3.2
|
||||
click==8.1.7
|
||||
colorama==0.4.6
|
||||
ghp-import==2.1.0
|
||||
griffe==1.1.0
|
||||
idna==3.7
|
||||
Jinja2==3.1.4
|
||||
loguru==0.7.2
|
||||
Markdown==3.7
|
||||
MarkupSafe==2.1.5
|
||||
maturin==1.7.0
|
||||
mergedeep==1.3.4
|
||||
mkautodoc==0.2.0
|
||||
mkautodocs==0.3.4.3
|
||||
mkdocs==1.6.0
|
||||
mkdocs-autorefs==1.0.1
|
||||
mkdocs-get-deps==0.2.0
|
||||
mkdocs-material==9.5.32
|
||||
mkdocs-material-extensions==1.3.1
|
||||
mkdocstrings==0.25.2
|
||||
mkdocstrings-python==1.10.8
|
||||
packaging==24.1
|
||||
paginate==0.5.6
|
||||
pathspec==0.12.1
|
||||
pdoc==14.6.0
|
||||
platformdirs==4.2.2
|
||||
Pygments==2.18.0
|
||||
pymdown-extensions==10.9
|
||||
python-dateutil==2.9.0.post0
|
||||
PyYAML==6.0.2
|
||||
pyyaml_env_tag==0.1
|
||||
regex==2024.7.24
|
||||
requests==2.32.3
|
||||
six==1.16.0
|
||||
urllib3==2.2.2
|
||||
watchdog==4.0.2
|
||||
Loading…
Add table
Add a link
Reference in a new issue