File: conf.py

package info (click to toggle)
python-agate 1.6.3-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,976 kB
  • sloc: python: 9,093; makefile: 126
file content (54 lines) | stat: -rw-r--r-- 1,206 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
#!/usr/bin/env python
# -*- coding: utf-8 -*-

import os
import sys

# Path munging
sys.path.insert(0, os.path.abspath('..'))

# Extensions
extensions = [
    'sphinx.ext.autosummary',
    'sphinx.ext.autodoc',
    'sphinx.ext.intersphinx'
]
# autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'show-inheritance']

intersphinx_mapping = {
    'python': (
        'http://docs.python.org/3',
        '/usr/share/doc/python3/html/objects.inv',
    ),
    'leather': (
        'http://leather.readthedocs.io/en/latest/',
        '/usr/share/doc/python-leather-doc/html/objects.inv',
    ),
}

# Templates
templates_path = ['_templates']
master_doc = 'index'

# Metadata
project = u'agate'
copyright = u'2017, Christopher Groskopf'
version = '1.6.3'
release = version

exclude_patterns = ['_build']
pygments_style = 'sphinx'

# HTMl theming
html_theme = 'default'

on_rtd = os.environ.get('READTHEDOCS', None) == 'True'

if not on_rtd:  # only import and set the theme if we're building docs locally
    import sphinx_rtd_theme
    html_theme = 'sphinx_rtd_theme'
    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

html_static_path = ['_static']
htmlhelp_basename = 'agatedoc'