aboutsummaryrefslogtreecommitdiff
path: root/doc/README.md
diff options
context:
space:
mode:
authorBen Gamari <ben@smart-cactus.org>2016-02-11 18:53:03 +0100
committerBen Gamari <ben@smart-cactus.org>2016-02-11 18:53:03 +0100
commit6a6029f1fc7b2cfeea8e231c8806d293d6644004 (patch)
treece187f3765d465f29b7e875d39f7e4ab63cd614b /doc/README.md
parent1ee7e9a058f035926ef9d37ef58af409e0c3c998 (diff)
parentbae468bb60c31ed0a24193ba50fa5f6953d10d3a (diff)
Merge pull request #480 from bgamari/sphinx
Move documentation to ReStructuredText
Diffstat (limited to 'doc/README.md')
-rw-r--r--doc/README.md23
1 files changed, 4 insertions, 19 deletions
diff --git a/doc/README.md b/doc/README.md
index cf1fc31b..947d7f93 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -1,25 +1,10 @@
# Haddock documentation
-The documentation is in DocBook XML format. You need some tools to
-process it: at least xsltproc, and the DocBook XML DTD and XSL
-stylesheets. There's a configure script to detect the right way to
-process the documentation on your system, and a Makefile to actually
-do the processing (so, on Windows, you'll need Cygwin or MSys in
-addition to the DocBook XML tools). To build the HTML documentation:
+The documentation is in ReStructuredText format. You need
+[Sphinx](http://www.sphinx-doc.org/) to process it. To build the HTML
+documentation,
- $ autoconf
- $ ./configure
$ make html
-which leaves the HTML documentation in a haddock/ subdirectory.
+which leaves the HTML documentation the `.build-html/` subdirectory.
-Printable documentation can also be produced, eg.:
-
- $ make pdf
-
-or
-
- $ make ps
-
-Generating the printed formats requires more tools (fop or xmltex) and
-tends to be a bit harder.