update docs readme

bagustris · Apr 18, 2024 · 3250e2a · 3250e2a
1 parent f06664e
commit 3250e2a
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -20,4 +20,12 @@ After that, check the built HTML in `build/html/index.html`
 firefox build/html/index.html
 ```
 
+## Generate RST files from docstring
+
+To generate RST files from docstring, you can use the following command:
+
+```bash
+sphinx-apidoc -f -o source/ ../nkululeko/
+```
+
 If found any issues, please report them [here](https://github.com/felixbur/nkululeko/issues).