Skip to content

Commit 47f1489

Browse files
committed
Document there is more documentation
README.md has a pointer or doc/ doc/README.md, new file, tells it sphinx-doc.
1 parent a6dc2f6 commit 47f1489

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ library. It also contains [YAML][3] parser (however, it tuned for
99
configuration parsing rather than generic YAML parser, e.g. it assumes YAML
1010
always fits memory).
1111

12+
See `doc/` for additional information.
1213

1314
[1]: http://github.com/tailhook/quire
1415
[2]: http://yaml.org

doc/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
doc/
2+
====
3+
4+
In this directory documentation in [sphinx-doc][1] format.
5+
6+
Type `make html` to get HTML generated. Expect to get errors
7+
when *sphinx-doc* is not installed on your system.
8+
9+
With `make` you get a list of possible output formats.
10+
11+
[1]: http://www.sphinx-doc.org/

0 commit comments

Comments
 (0)