forked from github.com/blag
WIP
This commit is contained in:
9
docs/api.md
Normal file
9
docs/api.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
::: blag.version
|
||||||
|
|
||||||
|
::: blag.blag
|
||||||
|
|
||||||
|
::: blag.markdown
|
||||||
|
|
||||||
|
::: blag.devserver
|
||||||
|
|
||||||
|
::: blag.quickstart
|
||||||
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.
|
||||||
19
mkdocs.yml
Normal file
19
mkdocs.yml
Normal file
@@ -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
|
||||||
@@ -1,5 +1,7 @@
|
|||||||
build==0.9.0
|
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
|
twine==4.0.2
|
||||||
wheel==0.40.0
|
wheel==0.40.0
|
||||||
pytest==7.3.0
|
pytest==7.3.0
|
||||||
|
|||||||
Reference in New Issue
Block a user