From 47f14899bb8e421cd608f76546ade95e6e5cc171 Mon Sep 17 00:00:00 2001 From: Geert Stappers Date: Sun, 21 Jul 2019 15:27:39 +0200 Subject: [PATCH] Document there is more documentation README.md has a pointer or doc/ doc/README.md, new file, tells it sphinx-doc. --- README.md | 1 + doc/README.md | 11 +++++++++++ 2 files changed, 12 insertions(+) create mode 100644 doc/README.md diff --git a/README.md b/README.md index e706db6..0910898 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ library. It also contains [YAML][3] parser (however, it tuned for configuration parsing rather than generic YAML parser, e.g. it assumes YAML always fits memory). +See `doc/` for additional information. [1]: http://github.com/tailhook/quire [2]: http://yaml.org diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000..d27ec78 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,11 @@ +doc/ +==== + +In this directory documentation in [sphinx-doc][1] format. + +Type `make html` to get HTML generated. Expect to get errors +when *sphinx-doc* is not installed on your system. + +With `make` you get a list of possible output formats. + +[1]: http://www.sphinx-doc.org/