diff --git a/szurubooru-client-docs/build.sh b/szurubooru-client-docs/build.sh new file mode 100755 index 0000000..d4f0157 --- /dev/null +++ b/szurubooru-client-docs/build.sh @@ -0,0 +1,3 @@ +#!/bin/bash + +maturin develop -F python -m ../szurubooru-client/Cargo.toml && mkdocs build diff --git a/szurubooru-client-docs/docs/index.md b/szurubooru-client-docs/docs/index.md new file mode 100644 index 0000000..92a7d48 --- /dev/null +++ b/szurubooru-client-docs/docs/index.md @@ -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: diff --git a/szurubooru-client-docs/mkdocs.yml b/szurubooru-client-docs/mkdocs.yml new file mode 100644 index 0000000..de3c42a --- /dev/null +++ b/szurubooru-client-docs/mkdocs.yml @@ -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 diff --git a/szurubooru-client-docs/requirements.txt b/szurubooru-client-docs/requirements.txt new file mode 100644 index 0000000..270010a --- /dev/null +++ b/szurubooru-client-docs/requirements.txt @@ -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