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
80
81
82
83
84
85
|
# -*- coding: utf-8 -*-
import datetime
import os
import re
import subprocess
import sys
def get_version():
proc = subprocess.Popen(
[sys.executable,
os.path.dirname(os.path.realpath(__file__)) +
'/../../scripts/scons_helpers/parse-version.py'],
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT)
return tuple(proc.stdout.read().decode().strip().split('.'))
# -- General configuration ------------------------------------------------
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinxemoji.sphinxemoji',
'breathe',
]
templates_path = []
source_suffix = ['.rst']
exclude_patterns = []
master_doc = 'index'
project = u'Roc Toolkit'
copyright = u'{}, Roc Streaming authors'.format(datetime.datetime.now().year)
author = u'Roc Streaming authors'
version_tuple = get_version()
version = 'Roc Toolkit {}'.format('.'.join(version_tuple[:2]))
release = '.'.join(version_tuple)
today_fmt = '%Y'
pygments_style = 'sphinx'
todo_include_todos = False
# -- Options for Breathe ----------------------------------------------
breathe_projects = { 'roc': '../../build/docs/public_api/xml' }
breathe_default_project = 'roc'
breathe_domain_by_extension = {'h': 'c'}
# -- Options for HTML output ----------------------------------------------
html_title = '{} {}'.format(project, release)
html_theme = 'nature'
html_logo = '../images/logo80.png'
html_sidebars = {
'**': ['globaltoc.html', 'searchbox.html'],
}
html_static_path = ['_static']
html_css_files = [
'roc.css',
]
html_js_files = [
'analytics.js',
]
# -- Options for manual page output ---------------------------------------
man_pages = [
('manuals/roc_send', 'roc-send', u'send real-time audio', [], 1),
('manuals/roc_recv', 'roc-recv', u'receive real-time audio', [], 1),
('manuals/roc_copy', 'roc-copy', u'copy local audio', [], 1),
]
|
