diff -r 000000000000 -r b2be9a32f3fc src/source/conf.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/source/conf.py Thu Dec 06 08:24:10 2018 +0100 @@ -0,0 +1,245 @@ +#!/var/local/env/pycharm/bin/python3.5 +# -*- coding: utf-8 -*- +# +# PyAMS User Guide documentation build configuration file, created by +# sphinx-quickstart on Fri Dec 15 17:15:54 2017. +# +# 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. + +# 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 sys +#sys.path.insert(0, '/var/local/env/pycharm/lib/python3.5/site-packages') + +import os + +prefix_path = os.path.abspath('../../../') + os.path.sep +sys.path[0:0] = list(map(lambda x: prefix_path + x, + [ + 'pyams_alchemy/src', + 'pyams_cache/src', + 'pyams_catalog/src', + 'pyams_content/src', + 'pyams_content_es/src', + 'pyams_default_theme/src', + 'pyams_file/src', + 'pyams_form/src', + 'pyams_gis/src', + 'pyams_i18n/src', + 'pyams_ldap/src', + 'pyams_mail/src', + 'pyams_media/src', + 'pyams_notify/src', + 'pyams_notify_ws/src', + 'pyams_pagelet/src', + 'pyams_portal/src', + 'pyams_scheduler/src', + 'pyams_security/src', + 'pyams_sequence/src', + 'pyams_skin/src', + 'pyams_template/src', + 'pyams_thesaurus/src', + 'pyams_utils/src', + 'pyams_viewlet/src', + 'pyams_workflow/src', + 'pyams_zmi/src', + 'pyams_zmq/src', + 'pyams_zodbbrowser/src', + ]) + ) + +# -- 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 = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.todo', + #'sphinx.ext.coverage', + 'sphinx.ext.viewcode', + 'repoze.sphinx.autointerface', +] + +autoclass_content = 'both' + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'PyAMS Documentation' +copyright = '2018, Thierry Florac' +author = 'Thierry Florac' + +# 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. +# +# The short X.Y version. +version = '0.1' +# The full version, including alpha/beta/rc tags. +release = '0.1.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = 'en' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'default' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + +# -- 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" + +# 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 = {} + +# 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'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# html_domain_indices = True + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'PyAMSDocumentation' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'PyAMSDocumentation.tex', 'PyAMS Documentation', + 'Thierry Florac', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'PyAMSDocumentation', 'PyAMS Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'PyAMSDocumentation', 'PyAMS Documentation', + author, 'PyAMSDocumentation', 'PyAMS a CMS based on Pyramid and Zope', + 'Miscellaneous'), +] + + + +# -- Options for Epub output ---------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project +epub_author = author +epub_publisher = author +epub_copyright = copyright + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# +# epub_identifier = '' + +# A unique identification for the text. +# +# epub_uid = '' + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] + + +try: + from zope.schema.fieldproperty import FieldProperty +except ImportError: + raise +else: + def get_field_doc(self): + field = self._FieldProperty__field + if field.title and field.description: + return '{0}: {1}'.format(field.title, field.description) + elif field.title: + return field.title + else: + return super(self.__class__, self).__doc__ + FieldProperty.__doc__ = property(get_field_doc) + + +def setup(app): + + app.add_stylesheet('css/custom.css') +