mrtoth/baseimage-tutorial-framework
1
0
Fork 0
mirror of https://github.com/avatao-content/baseimage-tutorial-framework synced 2024-11-22 16:21:31 +00:00
Code Issues Releases Wiki Activity

Add info on Sphinx-docs to README.md

Browse Source
This commit is contained in:
Kristóf Tóth 2018-06-01 16:23:44 +02:00
parent e80cce00f3
commit 7a67b68cba
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -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. 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. 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.