From 7a67b68cbaa4330732b44c56a1d686ebcc098a9a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krist=C3=B3f=20T=C3=B3th?= Date: Fri, 1 Jun 2018 16:23:44 +0200 Subject: [PATCH] Add info on Sphinx-docs to README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index e3b7f54..01b6933 100644 --- a/README.md +++ b/README.md @@ -80,4 +80,6 @@ The TFW message format: Most of the components you need have docstrings included (hang on tight, this is work in progress) – refer to them for usage info. +In the `docs` folder you can find our Sphinx-based API documentation, which you can build using the included `Makefile` (you need to have Sphinx installed, please reach out to us if you have trouble building the docs). + To get started you should take a look at the [test-tutorial-framework](https://github.com/avatao-content/test-tutorial-framework) repository, which serves as an example project as well.