-
Notifications
You must be signed in to change notification settings - Fork 1.9k
/
conf.py
142 lines (110 loc) · 4.62 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
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
# 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.
#
# import os
# import sys
import datetime
# sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------
project = 'CodeIgniter'
author = 'CodeIgniter Foundation'
year_now = datetime.date.today().year
copyright = '2019-' + str(year_now) + ' CodeIgniter Foundation'
# The short X.Y version.
version = '4.2'
# The full version, including alpha/beta/rc tags.
release = '4.2.12'
# -- General configuration ---------------------------------------------------
# The master toctree document.
master_doc = 'index'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinxcontrib.phpdomain',
'sphinx_rtd_theme',
]
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'trac'
# The default language to highlight source code in.
highlight_language = 'html+php'
# A dictionary of options that modify how the lexer specified by
# highlight_language generates highlighted source code.
highlight_options = {'startinline': True}
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'sphinx_rtd_theme'
# 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']
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
'collapse_navigation': False,
'sticky_navigation': False,
'navigation_depth': 2,
'includehidden': False,
'logo_only': True,
'display_version': False,
'style_nav_header_background': '#DD4814',
}
# 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'
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = '_static/ci-logo-text.png'
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
html_favicon = '_static/favicon.ico'
# The name of an style sheet to use for HTML pages.
html_style = 'css/citheme.css'
# Output file base name for HTML help builder.
htmlhelp_basename = 'CodeIgniterdoc'
# If true, the reST sources are included in the HTML build as _sources/name.
html_copy_source = False
# A list of CSS files.
html_css_files = []
# A list of JS files.
html_js_files = [
'js/citheme.js',
'js/carbon.js'
]
# -- Options for LaTeX output --------------------------------------------------
# This value determines how to group the document tree into LaTeX source files.
# It must be a list of tuples (startdocname, targetname, title, author, theme,
# toctree_only)
latex_documents = [
('index', 'CodeIgniter.tex', 'CodeIgniter4 Documentation',
'CodeIgniter Foundation', 'manual'),
]
# -- Options for manual page output --------------------------------------------
# This value determines how to group the document tree into manual pages. It
# must be a list of tuples (startdocname, name, description, authors, section)
man_pages = [
('index', 'codeigniter', 'CodeIgniter4 Documentation',
['CodeIgniter Foundation'], 1)
]
# -- Options for Epub output ---------------------------------------------------
# Bibliographic Dublin Core metadata.
epub_title = 'CodeIgniter4'
epub_author = 'CodeIgniter Foundation'
epub_publisher = 'CodeIgniter Foundation'
epub_copyright = copyright