Skip to content
This repository has been archived by the owner on Jan 29, 2023. It is now read-only.

Commit

Permalink
docs: add api reference
Browse files Browse the repository at this point in the history
  • Loading branch information
Rydra committed Jan 16, 2022
1 parent 4f72983 commit 899a844
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 1 deletion.
3 changes: 3 additions & 0 deletions docs/api-reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# API reference

::: melange.message_publisher
3 changes: 2 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
mkdocs-material
mkdocs-material
mkdocstrings
12 changes: 12 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,15 @@ markdown_extensions:
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences


plugins:
- search
- mkdocstrings


nav:
- Home: index.md
- Examples: installation.md
- Code Reference:
- API reference: api-reference.md

0 comments on commit 899a844

Please sign in to comment.