Sphinx cloud theme¶
See also
Contents
Introduction¶
This page contains examples of various features of the Cloud theme. It’s mainly useful internally, to make sure everything is displaying correctly.
Installation¶
pip install -U cloud_sptheme
Inline Text¶
Inline literal: ``literal text``.
Inline literal: literal text
.
External links are prefixed with an arrow: `<http://www.google.com>`_.
External links are prefixed with an arrow: http://www.google.com.
But email links are not prefixed: bob@example.com.
But email links are not prefixed: bob@example.com.
Issue tracker link: :issue:`5`.
extensions = [
# http://pythonhosted.org/cloud_sptheme/index.html#extensions
# https://bitbucket.org/ecollins/cloud_sptheme
'cloud_sptheme.ext.issue_tracker',
]
# set path to issue tracker:
issue_tracker_url = "https://bitbucket.org/ecollins/cloud_sptheme/issue/{issue}"
Admonition Styles¶
.. note::
This is a note.
Note
This is a note.
.. warning::
This is warning.
Warning
This is warning.
.. seealso::
This is a "see also" message.
See also
This is a “see also” message.
.. todo::
This is a todo message.
With some additional next on another line.
Todo
This is a todo message.
With some additional next on another line.
.. deprecated:: XXX This is a deprecation warning.
Deprecated since version XXX: This is a deprecation warning.
.. rst-class:: floater
.. note::
This is a floating note.
Note
This is a floating note.
Table Styles¶
extensions = [
# http://pythonhosted.org/cloud_sptheme/index.html#extensions
# https://bitbucket.org/ecollins/cloud_sptheme
'cloud_sptheme.ext.table_styling',
]
.. table:: Normal Table
Header1 |
Header2 |
Header3 |
---|---|---|
Row 1 |
Row 1 |
Row 1 |
Row 2 |
Row 2 |
Row 2 |
Row 3 |
Row 3 |
Row 3 |
.. rst-class:: plain
.. table:: Plain Table (no row shading)
Header1 |
Header2 |
Header3 |
---|---|---|
Row 1 |
Row 1 |
Row 1 |
Row 2 |
Row 2 |
Row 2 |
Row 3 |
Row 3 |
Row 3 |
.. rst-class:: centered
.. table:: Centered Table
Header1 |
Header2 |
Header3 |
---|---|---|
Row 1 |
Row 1 |
Row 1 |
Row 2 |
Row 2 |
Row 2 |
Row 3 |
Row 3 |
Row 3 |
.. rst-class:: fullwidth
.. table:: Full Width Table
Header1 |
Header2 |
Header3 |
---|---|---|
Row 1 |
Row 1 |
Row 1 |
Row 2 |
Row 2 |
Row 2 |
Row 3 |
Row 3 |
Row 3 |
.. table:: Table Styling Extension
:widths: 1 2 3
:header-columns: 1
:column-alignment: left center right
:column-dividers: none single double single
:column-wrapping: nnn
.. rst-class:: html-toggle
.. _toggle-test-link:
Toggleable Section¶
This section is collapsed by default. But if a visitor follows a link to this section or something within it (such as this), it will automatically be expanded.
.. rst-class:: html-toggle expanded
Section With Emphasized Children¶
Mainly useful for sections with many long subsections, where a second level of visual dividers would be useful.
Child Section¶
Should be have slightly lighter background, and be indented.
.. rst-class:: html-toggle
Toggleable Subsection¶
Test of emphasized + toggleable styles. Should be collapsed by default.
ReadTheDocs¶
To use this theme on http://readthedocs.org:
If it doesn’t already exist, add a pip
requirements.txt
file to your documentation (e.g. alongsideconf.py
). It should contain a minimum of the following lines:sphinx cloud_sptheme
… as well as any other build requirements for your project’s documentation.
When setting up your project on ReadTheDocs, enter the path to
requirements.txt
in the requirements file field on the project configuration page.ReadTheDocs will now automatically download the latest version of
cloud_sptheme
when building your documentation.
Project using cloud_sptheme¶
Passlib 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 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 | # -*- coding: utf-8 -*-
#
# Passlib documentation build configuration file, created by
# sphinx-quickstart on Mon Mar 2 14:12:06 2009.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
options = os.environ.get("PASSLIB_DOCS", "").split(",")
#make sure passlib in sys.path
doc_root = os.path.abspath(os.path.join(__file__,os.path.pardir))
source_root = os.path.abspath(os.path.join(doc_root,os.path.pardir))
sys.path.insert(0, source_root)
# 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.
#sys.path.insert(0, os.path.abspath('.'))
#building the docs requires the Cloud sphinx theme & extensions
# https://bitbucket.org/ecollins/cloud_sptheme
#which contains some sphinx extensions used by passlib
import cloud_sptheme as csp
#hack to make autodoc generate documentation from the correct class...
import passlib.utils.md4 as md4_mod
md4_mod.md4 = md4_mod._builtin_md4
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
# standard sphinx extensions
'sphinx.ext.autodoc',
'sphinx.ext.todo',
#add autdoc support for ReST sections in class/function docstrings
'cloud_sptheme.ext.autodoc_sections',
#adds extra ids & classes to genindex html, for additional styling
'cloud_sptheme.ext.index_styling',
#inserts toc into right hand nav bar (ala old style python docs)
'cloud_sptheme.ext.relbar_toc',
# add "issue" role
'cloud_sptheme.ext.issue_tracker',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
source_encoding = 'utf-8'
# The master toctree document.
master_doc = 'contents'
index_doc = 'index'
# General information about the project.
project = u'Passlib'
copyright = u'2008-2012, Assurance Technologies, LLC'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# version: The short X.Y version.
# release: The full version, including alpha/beta/rc tags.
from passlib import __version__ as release
version = csp.get_version(release)
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = [
# disabling documentation of this until module is more mature.
"lib/passlib.utils.compat.rst",
# may remove this in future release
"lib/passlib.utils.md4.rst",
]
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
modindex_common_prefix = [ "passlib." ]
# -- Options for all output ---------------------------------------------------
todo_include_todos = "hide-todos" not in options
keep_warnings = "hide-warnings" not in options
issue_tracker_url = "gc:passlib"
# -- 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 = 'redcloud'
# 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.
if html_theme in ['cloud', 'redcloud']:
html_theme_options = { "roottarget": index_doc, "collapsiblesidebar": True }
if 'for-pypi' in options:
html_theme_options['googleanalytics_id'] = 'UA-22302196-2'
html_theme_options['googleanalytics_path'] = '/passlib/'
else:
html_theme_options = {}
html_theme_options.update(issueicon=r'"\21D7"')
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [csp.get_theme_dir()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
html_title = project + " v" + release + " Documentation"
# A shorter title for the navigation bar. Default is the same as html_title.
html_short_title = project + " " + version + " Documentation"
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = os.path.join("_static", "masthead.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 = "logo.ico"
# 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']
# 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, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# 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 = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = project + 'Doc'
# -- Options for LaTeX output --------------------------------------------------
# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
#latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
(index_doc, project + '.tex', project + u' Documentation',
u'Assurance Technologies, LLC', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(index_doc, project, project + u' Documentation',
[u'Assurance Technologies, LLC'], 1)
]
|