From 2835f3ae42c82123e13322811857ee78bc0cb50c Mon Sep 17 00:00:00 2001 From: Konstantin Lampalzer Date: Sat, 16 Jan 2021 02:01:07 +0100 Subject: [PATCH] Add how to document your code in readme --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 54c07fb..50424e7 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,8 @@ Need dependencies: https://github.com/Freenove/Freenove_RPI_WS281x_Python + +# Writing docs + +[Inline documentation example](https://pythonhosted.org/an_example_pypi_project/sphinx.html#full-code-example) +[reStructured Text](https://pythonhosted.org/an_example_pypi_project/sphinx.html#restructured-text-rest-resources)