webfundamentals/conf.py at master · RunestoneInteractive/webfundamentals · GitHub

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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# -*- coding: utf-8 -*-

import sys, os

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
from runestone import runestone_static_dirs, runestone_extensions, setup
import pkg_resources

# -- General configuration -----------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ["sphinx.ext.mathjax"] + runestone_extensions()

templates_path = [
    pkg_resources.resource_filename("runestone", "common/project_template/_templates")
]

# The suffix of source filenames.
source_suffix = ".rst"

# The master toctree document.
master_doc = "index"

# General information about the project.
project = (
    "Fundamentals of Web Programming"  # e.g. How To Think Like a Computer Scientist
)
copyright = "2015 Brad Miller"  # e.g. "2013, Brad Miller and David Ranum"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ["ActiveIndexFiles/*"]

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"

# -- Options for HTML output ---------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the Sphinx documentation
# for a list of builtin themes.
html_theme = "sphinx_bootstrap"

# Theme options are theme-specific and customize the look and feel of a theme
html_theme_options = {
    # Navigation bar title. (Default: ``project`` value)
    "navbar_title": "Fundamentals of Web Programming",
    # Tab name for entire site. (Default: "Site")
    "navbar_site_name": "Chapters",
    # Global TOC depth for "site" navbar tab. (Default: 1)
    # Switching to -1 shows all levels.
    "globaltoc_depth": 1,
    # Include hidden TOCs in Site navbar?
    #
    # Note: If this is "false", you cannot have mixed ``:hidden:`` and
    # non-hidden ``toctree`` directives in the same page, or else the build
    # will break.
    #
    # Values: "true" (default) or "false"
    "globaltoc_includehidden": "true",
    # HTML navbar class (Default: "navbar") to attach to <div> element.
    # For dark navbar, do "navbar navbar-inverse"
    "navbar_class": "navbar",
    # Fix navigation bar to top of page?
    # Values: "true" (default) or "false"
    "navbar_fixed_top": "true",
    # Location of link to source.
    # Options are "nav" (default), "footer" or anything else to exclude.
    "source_link_position": "nav",
}

rst_prolog = (
    # For fill-in-the-blank questions, provide a convenient means to indicate a blank.
    """

.. |blank| replace:: :blank:`x`
"""
)

# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [
    pkg_resources.resource_filename(
        "runestone", "common/project_template/_templates/plugin_layouts"
    )
]

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
html_title = "Fundamentals of Web Programming"
shelf_section = 'Web programming'

# A shorter title for the navigation bar.  Default is the same as html_title.
html_short_title = "Fundamentals of Web Programming"

# Logo is currently included as CSS background in default layout file. If you remove
# it there, you should specify an alternative image here.
# html_logo = "../source/_static/logo_small.png"

# 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 = runestone_static_dirs() + ["./_static"]

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# html_last_updated_fmt = '%b %d, %Y'

# If true, links to the reST sources are added to the pages.
html_show_sourcelink = False

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
html_show_copyright = False

# Output file base name for HTML help builder.
htmlhelp_basename = "PythonCoursewareProjectdoc"