aboutsummaryrefslogtreecommitdiff
path: root/doc/conf.py
diff options
context:
space:
mode:
authorBen Gamari <ben@smart-cactus.org>2016-02-07 11:21:42 -0500
committerBen Gamari <ben@smart-cactus.org>2016-02-08 12:46:49 +0100
commitbfd47453c76c7fb849c50eed750f61e28dc5cbdb (patch)
tree780962886103957b9e3b13a19b651d4e9a1baf24 /doc/conf.py
parent8a4c949bfc731ef0dcd83d557da278d162152fb5 (diff)
doc: Switch to Sphinx
Diffstat (limited to 'doc/conf.py')
-rw-r--r--doc/conf.py69
1 files changed, 69 insertions, 0 deletions
diff --git a/doc/conf.py b/doc/conf.py
new file mode 100644
index 00000000..d6b8bda8
--- /dev/null
+++ b/doc/conf.py
@@ -0,0 +1,69 @@
+# -*- coding: utf-8 -*-
+
+import sys
+import os
+import shlex
+
+extensions = []
+
+source_suffix = '.rst'
+master_doc = 'index'
+
+# General information about the project.
+project = u'Haddock'
+copyright = u'2016, Simon Marlow'
+author = u'Simon Marlow'
+version = '1.0'
+release = '1.0'
+
+language = 'en'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['.build']
+todo_include_todos = False
+
+# Syntax highlighting
+highlight_language = 'haskell'
+pygments_style = 'tango'
+
+# -- Options for HTML output ----------------------------------------------
+
+html_theme = 'alabaster'
+htmlhelp_basename = 'Haddockdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = { }
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ (master_doc, 'Haddock.tex', u'Haddock Documentation',
+ u'Simon Marlow', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ (master_doc, 'haddock', u'Haddock Documentation',
+ [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ (master_doc, 'Haddock', u'Haddock Documentation',
+ author, 'Haddock', 'One line description of project.',
+ 'Miscellaneous'),
+]
+