From 6b928e4953bf521321e21ecfe074bbd1fb42014e Mon Sep 17 00:00:00 2001 From: Bastian Venthur Date: Fri, 16 Jun 2023 09:24:27 +0200 Subject: [PATCH] WIP --- docs/api.md | 9 +++++++++ docs/index.md | 17 +++++++++++++++++ mkdocs.yml | 19 +++++++++++++++++++ requirements-dev.txt | 4 +++- 4 files changed, 48 insertions(+), 1 deletion(-) create mode 100644 docs/api.md create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/docs/api.md b/docs/api.md new file mode 100644 index 0000000..874b638 --- /dev/null +++ b/docs/api.md @@ -0,0 +1,9 @@ +::: blag.version + +::: blag.blag + +::: blag.markdown + +::: blag.devserver + +::: blag.quickstart diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..000ea34 --- /dev/null +++ b/docs/index.md @@ -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. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..0d34f3f --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,19 @@ +site_name: blag +site_url: https://blag.readthedocs.io/ +nav: + - Home: index.md + - Manual: manual.md + - API: api.md +theme: material +repo_url: https://github.com/venthur/blag +repo_name: venthur/blag +plugins: + - search: + - mkdocstrings: + handlers: + python: + options: + docstring_style: numpy + allow_inspection: true + show_root_heading: true + show_if_no_docstring: true diff --git a/requirements-dev.txt b/requirements-dev.txt index 95c079a..2c806f0 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -1,5 +1,7 @@ build==0.9.0 -sphinx==5.3.0 +mkdocs==1.4.3 +mkdocs-material==9.1.15 +mkdocstrings[python]==0.20.0 twine==4.0.2 wheel==0.40.0 pytest==7.3.0