diff options
author | Ben Gamari <ben@smart-cactus.org> | 2016-02-11 18:53:03 +0100 |
---|---|---|
committer | Ben Gamari <ben@smart-cactus.org> | 2016-02-11 18:53:03 +0100 |
commit | 6a6029f1fc7b2cfeea8e231c8806d293d6644004 (patch) | |
tree | ce187f3765d465f29b7e875d39f7e4ab63cd614b /doc/conf.py | |
parent | 1ee7e9a058f035926ef9d37ef58af409e0c3c998 (diff) | |
parent | bae468bb60c31ed0a24193ba50fa5f6953d10d3a (diff) |
Merge pull request #480 from bgamari/sphinx
Move documentation to ReStructuredText
Diffstat (limited to 'doc/conf.py')
-rw-r--r-- | doc/conf.py | 69 |
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'), +] + |