Skip to content

Commit 12b83b7

Browse files
josegonzalezjosegonzalez
committed
docs: use nicer cakephp doc theme
1 parent f0982d7 commit 12b83b7

File tree

2 files changed

+87
-234
lines changed

2 files changed

+87
-234
lines changed

‎docs/conf.py‎

Lines changed: 72 additions & 234 deletions
Original file line numberDiff line numberDiff line change
@@ -1,255 +1,93 @@
11
# -*- coding: utf-8 -*-
2-
#
3-
# CakePHP-Upload documentation build configuration file, created by
4-
# sphinx-quickstart on Tue Aug 26 08:59:51 2014.
5-
#
6-
# This file is execfile()d with the current directory set to its
7-
# containing dir.
8-
#
9-
# Note that not all possible configuration values are present in this
10-
# autogenerated file.
11-
#
12-
# All configuration values have a default; values that are commented out
13-
# serve to show the default.
14-
15-
# If extensions (or modules to document with autodoc) are in another directory,
16-
# add these directories to sys.path here. If the directory is relative to the
17-
# documentation root, use os.path.abspath to make it absolute, like shown here.
18-
# sys.path.insert(0, os.path.abspath('.'))
19-
20-
# -- General configuration ------------------------------------------------
21-
22-
# If your documentation needs a minimal Sphinx version, state it here.
23-
# needs_sphinx = '1.0'
24-
25-
# Add any Sphinx extension module names here, as strings. They can be
26-
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
27-
# ones.
28-
extensions = []
29-
30-
# Add any paths that contain templates here, relative to this directory.
31-
templates_path = ['_templates']
32-
33-
# The suffix of source filenames.
34-
source_suffix = '.rst'
35-
36-
# The encoding of source files.
37-
# source_encoding = 'utf-8-sig'
38-
39-
# The master toctree document.
40-
master_doc = 'index'
41-
42-
# General information about the project.
43-
project = u'CakePHP-Upload'
44-
copyright = u'2014, Jose Diaz-Gonzalez'
45-
46-
# The version info for the project you're documenting, acts as replacement for
47-
# |version| and |release|, also used in various other places throughout the
48-
# built documents.
49-
#
50-
# The short X.Y version.
2+
import datetime
3+
import sys
4+
import os
5+
import cakephp_theme
6+
from sphinx.highlighting import lexers
7+
from pygments.lexers.php import PhpLexer
8+
9+
########################
10+
# Begin Customizations #
11+
########################
12+
13+
maintainer = u'josegonzalez'
14+
project = u'cakephp-upload'
15+
project_pretty_name = u'CakePHP Upload'
16+
copyright = u'%d, Jose Diaz-Gonzalez' % datetime.datetime.now().year
5117
version = '3.0.0'
52-
# The full version, including alpha/beta/rc tags.
5318
release = '3.0.0'
54-
55-
# The language for content autogenerated by Sphinx. Refer to documentation
56-
# for a list of supported languages.
57-
# language = None
58-
59-
# There are two options for replacing |today|: either, you set today to some
60-
# non-false value, then it is used:
61-
# today = ''
62-
# Else, today_fmt is used as the format for a strftime call.
63-
# today_fmt = '%B %d, %Y'
64-
65-
# List of patterns, relative to source directory, that match files and
66-
# directories to ignore when looking for source files.
67-
exclude_patterns = ['_build']
68-
69-
# The reST default role (used for this markup: `text`) to use for all
70-
# documents.
71-
# default_role = None
72-
73-
# If true, '()' will be appended to :func: etc. cross-reference text.
74-
# add_function_parentheses = True
75-
76-
# If true, the current module name will be prepended to all description
77-
# unit titles (such as .. function::).
78-
# add_module_names = True
79-
80-
# If true, sectionauthor and moduleauthor directives will be shown in the
81-
# output. They are ignored by default.
82-
# show_authors = False
83-
84-
# The name of the Pygments (syntax highlighting) style to use.
85-
pygments_style = 'sphinx'
86-
87-
# A list of ignored prefixes for module index sorting.
88-
# modindex_common_prefix = []
89-
90-
# If true, keep warnings as "system message" paragraphs in the built documents.
91-
# keep_warnings = False
92-
93-
94-
# -- Options for HTML output ----------------------------------------------
95-
96-
# The theme to use for HTML and HTML Help pages. See the documentation for
97-
# a list of builtin themes.
98-
html_theme = 'default'
99-
100-
# Theme options are theme-specific and customize the look and feel of a theme
101-
# further. For a list of options available for each theme, see the
102-
# documentation.
103-
# html_theme_options = {}
104-
105-
# Add any paths that contain custom themes here, relative to this directory.
106-
# html_theme_path = []
107-
108-
# The name for this set of Sphinx documents. If None, it defaults to
109-
# "<project> v<release> documentation".
110-
# html_title = None
111-
112-
# A shorter title for the navigation bar. Default is the same as html_title.
113-
# html_short_title = None
114-
115-
# The name of an image file (relative to this directory) to place at the top
116-
# of the sidebar.
117-
# html_logo = None
118-
119-
# The name of an image file (within the static path) to use as favicon of the
120-
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
121-
# pixels large.
122-
# html_favicon = None
123-
124-
# Add any paths that contain custom static files (such as style sheets) here,
125-
# relative to this directory. They are copied after the builtin static files,
126-
# so a file named "default.css" will overwrite the builtin "default.css".
127-
html_static_path = ['_static']
128-
129-
# Add any extra paths that contain custom files (such as robots.txt or
130-
# .htaccess) here, relative to this directory. These files are copied
131-
# directly to the root of the documentation.
132-
# html_extra_path = []
133-
134-
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
135-
# using the given strftime format.
136-
# html_last_updated_fmt = '%b %d, %Y'
137-
138-
# If true, SmartyPants will be used to convert quotes and dashes to
139-
# typographically correct entities.
140-
# html_use_smartypants = True
141-
142-
# Custom sidebar templates, maps document names to template names.
143-
# html_sidebars = {}
144-
145-
# Additional templates that should be rendered to pages, maps page names to
146-
# template names.
147-
# html_additional_pages = {}
148-
149-
# If false, no module index is generated.
150-
# html_domain_indices = True
151-
152-
# If false, no index is generated.
153-
# html_use_index = True
154-
155-
# If true, the index is split into individual pages for each letter.
156-
# html_split_index = False
157-
158-
# If true, links to the reST sources are added to the pages.
159-
# html_show_sourcelink = True
160-
161-
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
162-
# html_show_sphinx = True
163-
164-
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
165-
# html_show_copyright = True
166-
167-
# If true, an OpenSearch description file will be output, and all pages will
168-
# contain a <link> tag referring to it. The value of this option must be the
169-
# base URL from which the finished HTML is served.
170-
# html_use_opensearch = ''
171-
172-
# This is the file name suffix for HTML files (e.g. ".xhtml").
173-
# html_file_suffix = None
174-
175-
# Output file base name for HTML help builder.
176-
htmlhelp_basename = 'CakePHP-Uploaddoc'
177-
178-
179-
# -- Options for LaTeX output ---------------------------------------------
180-
181-
latex_elements = {
182-
# The paper size ('letterpaper' or 'a4paper').
183-
# 'papersize': 'letterpaper',
184-
185-
# The font size ('10pt', '11pt' or '12pt').
186-
# 'pointsize': '10pt',
187-
188-
# Additional stuff for the LaTeX preamble.
189-
# 'preamble': '',
19+
html_title = 'CakePHP Upload'
20+
html_context = {
21+
'maintainer': maintainer,
22+
'project_pretty_name': project_pretty_name,
23+
'projects': {
24+
'Annotation Control List': 'https://cakephp-annotation-control-list.readthedocs.io/',
25+
'Entity Versioning': 'https://cakephp-version.readthedocs.io/',
26+
'Fractal Entities': 'https://cakephp-fractal-entities.readthedocs.io/',
27+
'Mail Preview': 'https://cakephp-mail-preview.readthedocs.io/',
28+
'Queueing': 'https://cakephp-queuesadilla.readthedocs.io/',
29+
'Upload Behavior': 'https://cakephp-upload.readthedocs.io/',
30+
}
19031
}
19132

192-
# Grouping the document tree into LaTeX files. List of tuples
193-
# (source start file, target name, title,
194-
# author, documentclass [howto, manual, or own class]).
33+
htmlhelp_basename = 'cakephp-upload'
19534
latex_documents = [
196-
('index', 'CakePHP-Upload.tex', u'CakePHP-Upload Documentation',
35+
('index', 'cakephp-upload.tex', u'cakephp-upload',
19736
u'Jose Diaz-Gonzalez', 'manual'),
19837
]
38+
man_pages = [
39+
('index', 'cakephp-upload', u'CakePHP Upload Documentation',
40+
[u'Jose Diaz-Gonzalez'], 1)
41+
]
19942

200-
# The name of an image file (relative to this directory) to place at the top of
201-
# the title page.
202-
# latex_logo = None
203-
204-
# For "manual" documents, if this is true, then toplevel headings are parts,
205-
# not chapters.
206-
# latex_use_parts = False
207-
208-
# If true, show page references after internal links.
209-
# latex_show_pagerefs = False
210-
211-
# If true, show URL addresses after external links.
212-
# latex_show_urls = False
213-
214-
# Documents to append as an appendix to all manuals.
215-
# latex_appendices = []
43+
texinfo_documents = [
44+
('index', 'cakephp-upload', u'CakePHP Upload Documentation',
45+
u'Jose Diaz-Gonzalez', 'cakephp-upload', 'Handle file uploading sans ridiculous automagic',
46+
'Miscellaneous'),
47+
]
21648

217-
# If false, no module index is generated.
218-
# latex_domain_indices = True
49+
branch = 'master'
21950

51+
########################
52+
# End Customizations #
53+
########################
22054

221-
# -- Options for manual page output ---------------------------------------
55+
# -- General configuration ------------------------------------------------
22256

223-
# One entry per manual page. List of tuples
224-
# (source start file, name, description, authors, manual section).
225-
man_pages = [
226-
('index', 'cakephp-upload', u'CakePHP-Upload Documentation',
227-
[u'Jose Diaz-Gonzalez'], 1)
57+
extensions = [
58+
'sphinx.ext.todo',
59+
'sphinxcontrib.phpdomain',
60+
'_config.cakephpbranch',
22861
]
22962

230-
# If true, show URL addresses after external links.
231-
# man_show_urls = False
232-
63+
templates_path = ['_templates']
64+
source_suffix = '.rst'
65+
master_doc = 'contents'
66+
exclude_patterns = [
67+
'_build',
68+
'_themes',
69+
'_partials',
70+
]
23371

234-
# -- Options for Texinfo output -------------------------------------------
72+
pygments_style = 'sphinx'
73+
highlight_language = 'php'
23574

236-
# Grouping the document tree into Texinfo files. List of tuples
237-
# (source start file, target name, title, author,
238-
# dir menu entry, description, category)
239-
texinfo_documents = [
240-
('index', 'CakePHP-Upload', u'CakePHP-Upload Documentation',
241-
u'Jose Diaz-Gonzalez', 'CakePHP-Upload', 'One line description of project.',
242-
'Miscellaneous'),
243-
]
75+
# -- Options for HTML output ----------------------------------------------
24476

245-
# Documents to append as an appendix to all manuals.
246-
# texinfo_appendices = []
77+
html_theme = 'cakephp_theme'
78+
html_theme_path = [cakephp_theme.get_html_theme_path()]
79+
html_static_path = []
80+
html_last_updated_fmt = '%b %d, %Y'
81+
html_sidebars = {
82+
'**': ['globaltoc.html', 'localtoc.html']
83+
}
24784

248-
# If false, no module index is generated.
249-
# texinfo_domain_indices = True
85+
# -- Options for LaTeX output ---------------------------------------------
25086

251-
# How to display URL addresses: 'footnote', 'no', or 'inline'.
252-
# texinfo_show_urls = 'footnote'
87+
latex_elements = {
88+
}
25389

254-
# If true, do not generate a @detailmenu in the "Top" node's menu.
255-
# texinfo_no_detailmenu = False
90+
lexers['php'] = PhpLexer(startinline=True)
91+
lexers['phpinline'] = PhpLexer(startinline=True)
92+
lexers['php-annotations'] = PhpLexer(startinline=True)
93+
primary_domain = "php"

‎docs/requirements.txt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
alabaster==0.7.9
2+
Babel==2.3.4
3+
docutils==0.13.1
4+
imagesize==0.7.1
5+
Jinja2==2.8
6+
MarkupSafe==0.23
7+
Pygments==2.1.3
8+
pytz==2016.10
9+
requests==2.12.4
10+
six==1.10.0
11+
snowballstemmer==1.2.1
12+
Sphinx==1.5.1
13+
sphinx-rtd-theme==0.1.9
14+
sphinxcontrib-phpdomain==0.2.1
15+
cakephp-theme

0 commit comments

Comments
 (0)