diff options
author | Sasank Chilamkurthy <sasankchilamkurthy@gmail.com> | 2020-09-12 18:40:57 +0530 |
---|---|---|
committer | Sasank Chilamkurthy <sasankchilamkurthy@gmail.com> | 2020-09-12 18:40:57 +0530 |
commit | 5e3292cd1d82a39d5107a3c25695b36ab85ef01d (patch) | |
tree | 0d0eaef7fb6245687f86276a6c43d8207647ca35 | |
parent | a4fe9cc5f7583e1aa24226361a3ee381280d237c (diff) | |
download | swig-5e3292cd1d82a39d5107a3c25695b36ab85ef01d.tar.gz |
read me on how to write docs
-rw-r--r-- | SphinxDocs/README.md | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/SphinxDocs/README.md b/SphinxDocs/README.md index 1ba8c2101..f3fda7d88 100644 --- a/SphinxDocs/README.md +++ b/SphinxDocs/README.md @@ -12,4 +12,15 @@ Here is how to setup environment and build docs: * Build html: `make html` * Open `build/html/index.html` in a browser to browse docs -You might have to `make clean` if there are issues with generated html.
\ No newline at end of file +You might have to `make clean` if there are issues with generated html. + +## How to write docs + +Sphinx is fairly simple system to use. It uses a markup called restructured +text (rst) to write docs. You can read the following tutorials to get started +with rst and sphinx: + +* Learn RST in y minutes: https://learnxinyminutes.com/docs/rst/ +* reStructuredText Primer: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html +* Sphinx Quickstart: https://www.sphinx-doc.org/en/master/usage/quickstart.html +* Getting started with Sphinx: https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html |