From da4fbb1318cb44627b4805d6c1b15981712d1f02 Mon Sep 17 00:00:00 2001 From: benne238 Date: Fri, 7 May 2021 13:39:28 -0400 Subject: [PATCH] making docs preliminary docs --- docs/api/making-docs.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 docs/api/making-docs.md diff --git a/docs/api/making-docs.md b/docs/api/making-docs.md new file mode 100644 index 0000000..0e2ee6b --- /dev/null +++ b/docs/api/making-docs.md @@ -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. \ No newline at end of file