diff options
| author | Pliable Pixels <pliablepixels@users.noreply.github.com> | 2019-03-15 09:12:06 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-03-15 09:12:06 -0400 |
| commit | 937e66359d8c41fdd63d4c6f4d49c02df0bb1392 (patch) | |
| tree | b66c268676270d00bb6f41e9759a4b858661f1b5 /docs/index.rst | |
| parent | 0ff338a5dcad70956e18bc336b2bd79d152a23d9 (diff) | |
| parent | 143e6d4a5f2ecf4b83507bfe96ff6b98bcb40abe (diff) | |
Merge pull request #792 from pliablepixels/sphinx-doc
migrate to sphinx
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..f2eb5f96 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,27 @@ +.. zmNinja documentation master file, created by + sphinx-quickstart on Fri Mar 15 08:38:52 2019. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to zmNinja's documentation! +=================================== + +.. toctree:: + :hidden: + + FAQ + validating-api + source + desktop + + +:doc:`FAQ` + A detailed FAQ for zmNinja, including common issues related to installation, streaming and troubleshooting +:doc:`validating-api` + How to make sure your ZoneMinder installation has working/usable APIs +:doc:`desktop` + Various tips/tricks/shortcuts for the desktop port of zmNinja +:doc:`source` + For the brave souls who want to build from source, your questions answered + + |