PK C"J24 4 cakephp-theme-latest/objects.inv# Sphinx inventory version 2
# Project: doc-theme
# Version: 0.0.17
# The remainder of this file is compressed using zlib.
xڍM
@=EnGp붂v!ƙG:)6SlA]彗 ^{b*mK6bP"kuNc2yE3g:١˨$\#ɞP֮K
9jޫͺBް:UpHXR\Z]0'p!/MfS`zM@٫v`l0{PK C"JJ J " cakephp-theme-latest/contents.html
Contents
CakePHP Documentation Theme
A Sphinx theme for use with CakePHP projects.
Features
- Easy ability to install/use as a Python package (tip o’ the hat to Dave &
Eric’s sphinx_rtd_theme for
showing the way);
- CakePHP-based documentation theme
Project background
The CakePHP documentation theme is a theme made for use with CakePHP projects.
This allows developers to distribute their own documentation in a format that
adheres to the CakePHP documentation styleguide.
When Should I use this Theme?
This theme should be used when:
- You are developing a CakePHP-related plugin or project
- You are attempting to promote CakePHP
You should not use this project for:
- Projects not related to CakePHP, e.g. projects for other
frameworks or for strictly-php libraries
- You are misrepresenting the CakePHP, e.g. stating that your
project is an official project when it is not.
Please note that the above list is not exhaustive, and is
subject to change.
Installation
Requirements
- Python and Pip
- Sphinx 1.5+
Setup
- You will need to install the cakephp_theme package:
# from pypi
pip install cakephp_theme
# from github
pip install -e git+https://github.com/cakephp/doc-theme/#egg=cakephp_theme
Usage
Add the following to your conf.py
so the theme location is loaded:
import cakephp_theme
html_theme_path = [cakephp_theme.get_path()]
html_theme = 'cakephp_theme'
extensions = ['cakephp_theme']
Add an explicit html_context
setting so the theme’s
customized attributes are properly initialized:
html_context = {
'maintainer': 'Your Name',
'project_pretty_name': 'Your Project Name',
'projects': {
'CakePHP Book': 'https://book.cakephp.org/',
'Some other project': 'https://example.com/',
}
}
That’s it! You now have the CakePHP documentation theme set up.
PK C"Jm$! cakephp-theme-latest/.buildinfo# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config:
tags:
PK C"Jz ' cakephp-theme-latest/_static/sidebar.js/*
* sidebar.js
* ~~~~~~~~~~
*
* This script makes the Sphinx sidebar collapsible.
*
* .sphinxsidebar contains .sphinxsidebarwrapper. This script adds
* in .sphixsidebar, after .sphinxsidebarwrapper, the #sidebarbutton
* used to collapse and expand the sidebar.
*
* When the sidebar is collapsed the .sphinxsidebarwrapper is hidden
* and the width of the sidebar and the margin-left of the document
* are decreased. When the sidebar is expanded the opposite happens.
* This script saves a per-browser/per-session cookie used to
* remember the position of the sidebar among the pages.
* Once the browser is closed the cookie is deleted and the position
* reset to the default (expanded).
*
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
$(function() {
// global elements used by the functions.
// the 'sidebarbutton' element is defined as global after its
// creation, in the add_sidebar_button function
var bodywrapper = $('.bodywrapper');
var sidebar = $('.sphinxsidebar');
var sidebarwrapper = $('.sphinxsidebarwrapper');
// for some reason, the document has no sidebar; do not run into errors
if (!sidebar.length) return;
// original margin-left of the bodywrapper and width of the sidebar
// with the sidebar expanded
var bw_margin_expanded = bodywrapper.css('margin-left');
var ssb_width_expanded = sidebar.width();
// margin-left of the bodywrapper and width of the sidebar
// with the sidebar collapsed
var bw_margin_collapsed = '.8em';
var ssb_width_collapsed = '.8em';
// colors used by the current theme
var dark_color = $('.related').css('background-color');
var light_color = $('.document').css('background-color');
function sidebar_is_collapsed() {
return sidebarwrapper.is(':not(:visible)');
}
function toggle_sidebar() {
if (sidebar_is_collapsed())
expand_sidebar();
else
collapse_sidebar();
}
function collapse_sidebar() {
sidebarwrapper.hide();
sidebar.css('width', ssb_width_collapsed);
bodywrapper.css('margin-left', bw_margin_collapsed);
sidebarbutton.css({
'margin-left': '0',
'height': bodywrapper.height()
});
sidebarbutton.find('span').text('»');
sidebarbutton.attr('title', _('Expand sidebar'));
document.cookie = 'sidebar=collapsed';
}
function expand_sidebar() {
bodywrapper.css('margin-left', bw_margin_expanded);
sidebar.css('width', ssb_width_expanded);
sidebarwrapper.show();
sidebarbutton.css({
'margin-left': ssb_width_expanded-12,
'height': bodywrapper.height()
});
sidebarbutton.find('span').text('«');
sidebarbutton.attr('title', _('Collapse sidebar'));
document.cookie = 'sidebar=expanded';
}
function add_sidebar_button() {
sidebarwrapper.css({
'float': 'left',
'margin-right': '0',
'width': ssb_width_expanded - 28
});
// create the button
sidebar.append(
''
);
var sidebarbutton = $('#sidebarbutton');
light_color = sidebarbutton.css('background-color');
// find the height of the viewport to center the '<<' in the page
var viewport_height;
if (window.innerHeight)
viewport_height = window.innerHeight;
else
viewport_height = $(window).height();
sidebarbutton.find('span').css({
'display': 'block',
'margin-top': (viewport_height - sidebar.position().top - 20) / 2
});
sidebarbutton.click(toggle_sidebar);
sidebarbutton.attr('title', _('Collapse sidebar'));
sidebarbutton.css({
'color': '#FFFFFF',
'border-left': '1px solid ' + dark_color,
'font-size': '1.2em',
'cursor': 'pointer',
'height': bodywrapper.height(),
'padding-top': '1px',
'margin-left': ssb_width_expanded - 12
});
sidebarbutton.hover(
function () {
$(this).css('background-color', dark_color);
},
function () {
$(this).css('background-color', light_color);
}
);
}
function set_position_from_cookie() {
if (!document.cookie)
return;
var items = document.cookie.split(';');
for(var k=0; k