diff options
| author | Sasank Chilamkurthy <sasankchilamkurthy@gmail.com> | 2020-09-12 18:33:00 +0530 |
|---|---|---|
| committer | Sasank Chilamkurthy <sasankchilamkurthy@gmail.com> | 2020-09-12 18:33:00 +0530 |
| commit | a4fe9cc5f7583e1aa24226361a3ee381280d237c (patch) | |
| tree | c01742219df0e43d195dfa24fea78a5c79b58dd5 | |
| parent | edbf6240bae89e76f91012c6733ac9f987413d96 (diff) | |
| download | swig-a4fe9cc5f7583e1aa24226361a3ee381280d237c.tar.gz | |
Add readme for docs
| -rw-r--r-- | SphinxDocs/README.md | 15 | ||||
| -rw-r--r-- | SphinxDocs/requirements.txt | 2 |
2 files changed, 17 insertions, 0 deletions
diff --git a/SphinxDocs/README.md b/SphinxDocs/README.md new file mode 100644 index 000000000..1ba8c2101 --- /dev/null +++ b/SphinxDocs/README.md @@ -0,0 +1,15 @@ +# Swig Documentation + +Swig used to use html files for documentation. It moved to sphinx and rst +because handcrafted html files are harder to maintain. + +## How to build docs + +Here is how to setup environment and build docs: + +* Install python3: `sudo apt-get install python3 python3-pip` +* Install dependencies: `pip install -r requirements.txt` +* 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 diff --git a/SphinxDocs/requirements.txt b/SphinxDocs/requirements.txt new file mode 100644 index 000000000..cbf1e3658 --- /dev/null +++ b/SphinxDocs/requirements.txt @@ -0,0 +1,2 @@ +sphinx +sphinx-rtd-theme |