This repository has been archived by the owner on May 1, 2024. It is now read-only.
/
conf.py
79 lines (62 loc) · 2.22 KB
/
conf.py
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# -*- coding: utf-8 -*-
#
import os
import sys
import urllib
import os.path
sys.path.insert(0, os.path.abspath('../src'))
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.viewcode',
'sphinxcontrib.napoleon'
]
# Napoleon settings
napoleon_google_docstring = True
napoleon_numpy_docstring = False
napoleon_include_private_with_doc = False
napoleon_include_special_with_doc = True
# Document all methods in classes
autoclass_content = 'both'
# Sorting of items
autodoc_member_order = "bysource"
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'pyDHTMLParser'
copyright = u'Bystroushaak'
# The full version, including alpha/beta/rc tags.
try:
# read data from CHANGES.rst
sys.path.insert(0, os.path.abspath('../'))
from docs import get_version
release = get_version(open("../CHANGES.rst").read())
except:
# this is here specially for readthedocs, which downloads only docs, not
# other files
fh = urllib.urlopen("https://pypi.python.org/pypi/" + project + "/")
release = filter(lambda x: "<title>" in x, fh.read().splitlines())
release = release[0].split(":")[0].split()[1]
# The short X.Y version.
version = ".".join(release.split(".")[:2])
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# If true, links to the reST sources are added to the pages.
html_show_sourcelink = True
# Output file base name for HTML help builder.
htmlhelp_basename = 'dhtmlparser'