Ubiquity  2.0.2
php rapid development framework
conf.py
Go to the documentation of this file.
1 #!/usr/bin/env python3
2 # -*- coding: utf-8 -*-
3 #
4 # Ubiquity-framework documentation build configuration file, created by
5 # sphinx-quickstart on Thu Apr 13 01:25:25 2017.
6 #
7 # This file is execfile()d with the current directory set to its
8 # containing dir.
9 #
10 # Note that not all possible configuration values are present in this
11 # autogenerated file.
12 #
13 # All configuration values have a default; values that are commented out
14 # serve to show the default.
15 
16 # If extensions (or modules to document with autodoc) are in another directory,
17 # add these directories to sys.path here. If the directory is relative to the
18 # documentation root, use os.path.abspath to make it absolute, like shown here.
19 #
20 # import os
21 # import sys
22 # sys.path.insert(0, os.path.abspath('.'))
23 
24 
25 # -- General configuration ------------------------------------------------
26 
27 # If your documentation needs a minimal Sphinx version, state it here.
28 #
29 # needs_sphinx = '1.0'
30 
31 # Add any Sphinx extension module names here, as strings. They can be
32 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
33 # ones.
34 extensions = []
35 
36 # Add any paths that contain templates here, relative to this directory.
37 templates_path = ['_templates']
38 
39 # The suffix(es) of source filenames.
40 # You can specify multiple suffix as a list of string:
41 #
42 # source_suffix = ['.rst', '.md']
43 source_suffix = '.rst'
44 
45 # The master toctree document.
46 master_doc = 'index'
47 
48 # General information about the project.
49 project = 'Ubiquity'
50 copyright = '2018, phpmv'
51 author = 'phpmv'
52 
53 # The version info for the project you're documenting, acts as replacement for
54 # |version| and |release|, also used in various other places throughout the
55 # built documents.
56 #
57 # The short X.Y version.
58 version = '2.0'
59 # The full version, including alpha/beta/rc tags.
60 release = '2.0.0'
61 
62 # The language for content autogenerated by Sphinx. Refer to documentation
63 # for a list of supported languages.
64 #
65 # This is also used if you do content translation via gettext catalogs.
66 # Usually you set "language" from the command line for these cases.
67 language = None
68 
69 # List of patterns, relative to source directory, that match files and
70 # directories to ignore when looking for source files.
71 # This patterns also effect to html_static_path and html_extra_path
72 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
73 
74 # The name of the Pygments (syntax highlighting) style to use.
75 pygments_style = 'monokai'
76 
77 # If true, `todo` and `todoList` produce output, else they produce nothing.
78 todo_include_todos = False
79 
80 
81 # -- Options for HTML output ----------------------------------------------
82 
83 # The theme to use for HTML and HTML Help pages. See the documentation for
84 # a list of builtin themes.
85 #
86 html_theme = 'sphinx_rtd_theme'
87 
88 # Theme options are theme-specific and customize the look and feel of a theme
89 # further. For a list of options available for each theme, see the
90 # documentation.
91 #
92 html_theme_options = {'navigation_depth': 4,}
93 
94 # Add any paths that contain custom static files (such as style sheets) here,
95 # relative to this directory. They are copied after the builtin static files,
96 # so a file named "default.css" will overwrite the builtin "default.css".
97 html_static_path = ['_static']
98 
99 
100 # -- Options for HTMLHelp output ------------------------------------------
101 
102 # Output file base name for HTML help builder.
103 htmlhelp_basename = 'micro-frameworkdoc'
104 
105 
106 # -- Options for LaTeX output ---------------------------------------------
107 
108 latex_elements = {
109  # The paper size ('letterpaper' or 'a4paper').
110  #
111  # 'papersize': 'letterpaper',
112 
113  # The font size ('10pt', '11pt' or '12pt').
114  #
115  # 'pointsize': '10pt',
116 
117  # Additional stuff for the LaTeX preamble.
118  #
119  # 'preamble': '',
120 
121  # Latex figure (float) alignment
122  #
123  # 'figure_align': 'htbp',
124 }
125 
126 # Grouping the document tree into LaTeX files. List of tuples
127 # (source start file, target name, title,
128 # author, documentclass [howto, manual, or own class]).
129 latex_documents = [
130  (master_doc, 'micro-framework.tex', 'micro-framework Documentation',
131  'phpmv', 'manual'),
132 ]
133 
134 
135 # -- Options for manual page output ---------------------------------------
136 
137 # One entry per manual page. List of tuples
138 # (source start file, name, description, authors, manual section).
139 man_pages = [
140  (master_doc, 'micro-framework', 'micro-framework Documentation',
141  [author], 1)
142 ]
143 
144 
145 # -- Options for Texinfo output -------------------------------------------
146 
147 # Grouping the document tree into Texinfo files. List of tuples
148 # (source start file, target name, title, author,
149 # dir menu entry, description, category)
150 texinfo_documents = [
151  (master_doc, 'micro-framework', 'micro-framework Documentation',
152  author, 'micro-framework', 'One line description of project.',
153  'Miscellaneous'),
154 ]
155 
156 def setup(app):
157  app.add_stylesheet('css/custom.css')
158 
159 # load PhpLexer
160 from sphinx.highlighting import lexers
161 from pygments.lexers.web import PhpLexer
162 
163 # enable highlighting for PHP code not between <?php ... ?> by default
164 lexers['php'] = PhpLexer(startinline=True)
165 lexers['php-annotations'] = PhpLexer(startinline=True)
def setup(app)
Definition: conf.py:156