pvAccessCPP  7.1.7
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
conf.py
1 # Configuration file for the Sphinx documentation builder.
2 #
3 # This file only contains a selection of the most common options. For a full
4 # list see the documentation:
5 # http://www.sphinx-doc.org/en/master/config
6 
7 # -- Path setup --------------------------------------------------------------
8 
9 # If extensions (or modules to document with autodoc) are in another directory,
10 # add these directories to sys.path here. If the directory is relative to the
11 # documentation root, use os.path.abspath to make it absolute, like shown here.
12 #
13 # import os
14 # import sys
15 # sys.path.insert(0, os.path.abspath('.'))
16 
17 
18 # -- Project information -----------------------------------------------------
19 
20 project = 'EPICS Documentation'
21 copyright = '2019, EPICS Controls.'
22 author = 'EPICS'
23 
24 
25 # -- General configuration ---------------------------------------------------
26 
27 # Add any Sphinx extension module names here, as strings. They can be
28 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
29 # ones.
30 extensions = [
31  'sphinx.ext.intersphinx',
32 ]
33 
34 # Add any paths that contain templates here, relative to this directory.
35 templates_path = ['_templates']
36 
37 # List of patterns, relative to source directory, that match files and
38 # directories to ignore when looking for source files.
39 # This pattern also affects html_static_path and html_extra_path.
40 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
41 
42 # Intersphinx links to subprojects
43 intersphinx_mapping = {
44  'how-tos': ('https://docs.epics-controls.org/projects/how-tos/en/latest', None),
45 }
46 
47 
48 # -- Options for HTML output -------------------------------------------------
49 
50 # The theme to use for HTML and HTML Help pages. See the documentation for
51 # a list of builtin themes.
52 #
53 html_theme = 'sphinx_rtd_theme'
54 
55 
56 # Add any paths that contain custom static files (such as style sheets) here,
57 # relative to this directory. They are copied after the builtin static files,
58 # so a file named "default.css" will overwrite the builtin "default.css".
59 html_static_path = ['_static']
60 
61 html_css_files = [
62  'css/custom.css',
63 ]
64 
65 master_doc = 'index'
66 
67 html_theme_options = {
68  'logo_only': True,
69 }
70 html_logo = "images/EPICS_white_logo_v02.png"
71 
72 html_extra_path = ['../html']
73 
74 
75 # -- Run Doxygen ------------------------------------------------------------
76 
77 import subprocess
78 subprocess.call('cd ..; mkdir -p html/doxygen; doxygen', shell=True)