Document the Semigroup for Map
[packages/containers.git] / docs / conf.py
1 # -*- coding: utf-8 -*-
2 #
3
4 from docutils.parsers.rst import roles
5 from docutils import nodes
6 import itertools
7 import string
8 import os
9 import sphinx_rtd_theme
10 import sys
11
12
13 # -- General configuration ------------------------------------------------
14
15 # Add the _extenions dir to the search path.
16 sys.path.insert(0, os.path.abspath('.') + '/_extensions')
17 sys.path.insert(0, os.path.abspath('.') + '/_extensions/haddock-autolink')
18
19 extensions = ['sphinx.ext.intersphinx',
20 'sphinx.ext.ifconfig',
21 'haddock-autolink',
22 'hs-theme']
23
24 templates_path = ['_templates']
25
26 source_suffix = '.rst'
27
28 master_doc = 'index'
29
30 # General information about the project.
31 project = u'containers'
32 copyright = u'2018, Matt Renaud'
33 author = u'Matt Renaud'
34
35 # The short X.Y version.
36 version = u'0.5.10'
37 # The full version, including alpha/beta/rc tags.
38 release = u'0.5.10.2'
39
40 # The language for content autogenerated by Sphinx. Refer to documentation
41 # for a list of supported languages.
42 language = None
43
44 # List of patterns, relative to source directory, that match files and
45 # directories to ignore when looking for source files.
46 # This patterns also effect to html_static_path and html_extra_path
47 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
48
49 # The name of the Pygments (syntax highlighting) style to use.
50 pygments_style = 'friendly'
51
52 # If true, `todo` and `todoList` produce output, else they produce nothing.
53 todo_include_todos = False
54
55
56 # -- Options for HTML output ----------------------------------------------
57
58 # on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
59 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
60
61 # The theme to use for HTML and HTML Help pages. See the documentation for
62 # a list of builtin themes.
63 #
64 if not on_rtd: # only import and set the theme if we're building docs locally
65 import sphinx_rtd_theme
66 html_theme = 'sphinx_rtd_theme'
67 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
68
69 # Theme options are theme-specific and customize the look and feel of a theme
70 # further. For a list of options available for each theme, see the
71 # documentation.
72 #
73 # html_theme_options = {}
74
75 # Add any paths that contain custom static files (such as style sheets) here,
76 # relative to this directory. They are copied after the builtin static files,
77 # so a file named "default.css" will overwrite the builtin "default.css".
78 html_logo = '_static/images/haskell-logo-green.svg'
79 html_static_path = ['_static']
80 html_context = {
81 'source_url_prefix': "https://github.com/haskell/containers/tree/master/docs/",
82 "display_github": True,
83 "github_host": "github.com",
84 "github_user": "haskell",
85 "github_repo": 'containers',
86 "github_version": "master/",
87 "conf_py_path": "docs/",
88 "source_suffix": '.rst',
89 }
90
91 # Custom sidebar templates, must be a dictionary that maps document names
92 # to template names.
93 #
94 # This is required for the alabaster theme
95 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
96 html_sidebars = {
97 '**': [
98 'relations.html', # needs 'show_related': True theme option to display
99 'searchbox.html',
100 ]
101 }