Skip to content

Commit

Permalink
making docs preliminary docs
Browse files Browse the repository at this point in the history
  • Loading branch information
benne238 committed May 7, 2021
1 parent 80ee836 commit da4fbb1
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/api/making-docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Making Docs

The api documentation uses mkdocs to create documenation, which is based in markdown.

All of the doucmentation can be found in the `docs` directory in the `webqueue2-api` repo, and all of the api specific documentation can be found in the `docs/api` directory.


## Mkdocs configuration

A basic version of mkdocs can be installed by using `pip install mkdocs`, however, this is not recomened as the current implementation makes use of several plugins that enahance the basic features of mkdocs. To install all of the dependencies for this, follow the steps for setting up the dev environment.

0 comments on commit da4fbb1

Please sign in to comment.