From 77a30d36717bfa03f017a6255951696abc384740 Mon Sep 17 00:00:00 2001 From: benoitc Date: Thu, 26 Dec 2013 13:19:15 +0100 Subject: [PATCH] ease the doc. test with the default rtd theme --- docs/Makefile | 2 +- docs/source/conf.py | 203 +++------------------------------------ docs/source/settings.rst | 21 +++- requirements_dev.txt | 2 + 4 files changed, 33 insertions(+), 195 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index ed384496..b3a79734 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -3,7 +3,7 @@ # You can set these variables from the command line. SPHINXOPTS = -SPHINXBUILD = ../bin/sphinx-build +SPHINXBUILD = sphinx-build PAPER = BUILDDIR = build diff --git a/docs/source/conf.py b/docs/source/conf.py index 55c846e8..ac434825 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,248 +1,67 @@ # -*- coding: utf-8 -*- # -# Gunicorn documentation build configuration file, created by -# sphinx-quickstart on Wed Oct 3 04:59:09 2012. +# Gunicorn documentation build configuration file # -# 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 -# 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('.')) - -# -- 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. - DOCS_DIR = os.path.abspath(os.path.dirname(__file__)) + +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + # for gunicorn_ext.py sys.path.append(os.path.join(DOCS_DIR, os.pardir)) -# To make sure we get this version of gunicorn sys.path.insert(0, os.path.join(DOCS_DIR, os.pardir, os.pardir)) extensions = ['gunicorn_ext'] - -# 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-sig' - -# The master toctree document. master_doc = 'index' # General information about the project. project = u'Gunicorn' copyright = u'2012, Benoit Chesneau' - -# 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. +# gunicorn version import gunicorn release = version = gunicorn.__version__ -# 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 = [] - -# 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 = [] - # -- 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 = 'default' +if not on_rtd: # only import and set the theme if we're building docs locally + import sphinx_rtd_theme + html_theme = 'sphinx_rtd_theme' + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] +else: + html_theme = 'default' -# 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 themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# 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 = None - -# 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 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 = 'Gunicorndoc' # -- 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': '', } -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', 'Gunicorn.tex', u'Gunicorn Documentation', u'Benoit Chesneau', '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 - -# 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', 'gunicorn', u'Gunicorn Documentation', [u'Benoit Chesneau'], 1) ] -# If true, show URL addresses after external links. -#man_show_urls = False - - -# -- 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 = [ ('index', 'Gunicorn', u'Gunicorn Documentation', u'Benoit Chesneau', 'Gunicorn', 'One line description of project.', 'Miscellaneous'), ] -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' diff --git a/docs/source/settings.rst b/docs/source/settings.rst index ad8cac63..719022e9 100644 --- a/docs/source/settings.rst +++ b/docs/source/settings.rst @@ -257,7 +257,7 @@ chdir ~~~~~ * ``--chdir`` -* ``/Users/benoitc/work/offset_pypy/src/gunicorn/docs`` +* ``/Users/benoitc/work/gunicorn_env/src/gunicorn/docs`` Chdir to specified directory before apps loading. @@ -462,7 +462,7 @@ logger_class ~~~~~~~~~~~~ * ``--logger-class STRING`` -* ``simple`` +* ``gunicorn.glogging.Logger`` The logger you want to use to log events in gunicorn. @@ -673,6 +673,19 @@ Called just after a worker has initialized the application. The callable needs to accept one instance variable for the initialized Worker. +worker_int +~~~~~~~~~~ + +* :: + + def worker_int(worker): + pass + +Called just after a worker exited on SIGINT or SIGTERM. + +The callable needs to accept one instance variable for the initialized +Worker. + pre_exec ~~~~~~~~ @@ -773,6 +786,10 @@ proxy_allow_ips Front-end's IPs from which allowed accept proxy requests (comma separate). +Set to "*" to disable checking of Front-end IPs (useful for setups +where you don't know in advance the IP address of Front-end, but +you still trust the environment) + Ssl --- diff --git a/requirements_dev.txt b/requirements_dev.txt index 5e64ba77..5dabec08 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -1,3 +1,5 @@ py==1.4.19 pytest==2.5.1 pytest-cov==1.6 +sphinx +sphinx_rtd_theme