From 0435ccd15f7c7c3960208d0bac413cd8eb42cd56 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Sat, 6 Apr 2013 08:11:45 +0200 Subject: trim commented-out parts of docs/conf.py proposed here: https://groups.google.com/forum/?fromgroups=#!topic/pylons-devel/n2-7zvLWK3E --- docs/conf.py | 91 ++---------------------------------------------------------- 1 file changed, 2 insertions(+), 89 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 1ddcae08e..33bedc9dd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -101,39 +101,19 @@ release = version # Else, today_fmt is used as the format for a strftime call. today_fmt = '%B %d, %Y' -# List of documents that shouldn't be included in the build. -#unused_docs = [] - # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_themes/README.rst', ] -# List of directories, relative to source directories, that shouldn't be searched -# for source files. -#exclude_dirs = [] - -# 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 = False -# 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 = book and 'bw' or 'tango' if book: pygments_style = 'bw' -# The default language to highlight source code in. -#highlight_language = 'guess' - # Options for HTML output # ----------------------- @@ -169,67 +149,15 @@ html_theme_options = dict( github_url='https://github.com/Pylons/pyramid', # in_progress='true', ) -# The style sheet to use for HTML and HTML Help pages. A file of that name -# must exist either in Sphinx' static/ path, or in one of the custom paths -# given in html_static_path. -#html_style = 'pyramid.css' # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". html_title = 'The Pyramid Web Application Development Framework v%s' % release -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = 'Home' - -# The name of an image file (within the static path) to place at the top of -# the sidebar. -#html_logo = '_static/pyramid.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 = '_static/pyramid.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_use_modindex = 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, the reST sources are included in the HTML build as _sources/. -#html_copy_source = 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 = '' - -# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = '' - # Output file base name for HTML help builder. htmlhelp_basename = 'pyramid' @@ -252,20 +180,10 @@ latex_documents = [ 'Chris McDonough', 'manual'), ] -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = '_static/pylons_small.png' - # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. latex_use_parts = True -# 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_use_modindex = False @@ -508,13 +426,6 @@ epub_identifier = '0615445675' # A unique identification for the text. epub_uid = 'The Pyramid Web Application Development Framework, Version %s' \ % release -# HTML files that should be inserted before the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_pre_files = [] - -# HTML files shat should be inserted after the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_post_files = [] # A list of files that should not be packed into the epub file. epub_exclude_files = ['_static/opensearch.xml', '_static/doctools.js', @@ -524,3 +435,5 @@ epub_exclude_files = ['_static/opensearch.xml', '_static/doctools.js', # The depth of the table of contents in toc.ncx. epub_tocdepth = 3 + +# For a list of all settings, visit http://sphinx-doc.org/config.html. -- cgit v1.2.3 From 66be39bf656a2840931603bc959e38ff95e53164 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Wed, 2 Oct 2013 15:35:24 -0400 Subject: - Removed mention of ``pyramid_beaker`` from docs. Beaker is no longer maintained. Point people at ``pyramid_redis_sessions`` instead. --- docs/conf.py | 3 --- 1 file changed, 3 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index ee852aa51..3b6e75a17 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -73,9 +73,6 @@ intersphinx_mapping = { 'http://docs.pylonsproject.org/projects/deform/en/latest', None), 'sqla': ('http://docs.sqlalchemy.org/en/latest', None), - 'beaker': ( - 'http://docs.pylonsproject.org/projects/pyramid_beaker/en/latest', - None), 'who': ('http://docs.repoze.org/who/latest', None), 'python': ('http://docs.python.org', None), 'python3': ('http://docs.python.org/3', None), -- cgit v1.2.3 From 6a3eed4ddc4178d19c0002ec72b9a1d6494e01ae Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Tue, 8 Oct 2013 00:40:15 -0700 Subject: - remove . from end of URL --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index f18cf3ec3..ec62faa99 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -458,4 +458,4 @@ epub_exclude_files = ['_static/opensearch.xml', '_static/doctools.js', # The depth of the table of contents in toc.ncx. epub_tocdepth = 3 -# For a list of all settings, visit http://sphinx-doc.org/config.html. +# For a list of all settings, visit http://sphinx-doc.org/config.html -- cgit v1.2.3 From a10a8f56d0c4efc232e3138e5d97eff06efd52d1 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Mon, 14 Oct 2013 16:35:45 +0200 Subject: temporarily dont run tests to see impact on readthedocs --- docs/conf.py | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index ec62faa99..490df48cc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -150,16 +150,16 @@ if 'sphinx-build' in ' '.join(sys.argv): # protect against dumb importers sys.path.append(os.path.abspath('_themes')) - parent = os.path.dirname(os.path.dirname(__file__)) - sys.path.append(os.path.abspath(parent)) - wd = os.getcwd() - os.chdir(parent) - os.system('%s setup.py test -q' % sys.executable) - os.chdir(wd) - - for item in os.listdir(parent): - if item.endswith('.egg'): - sys.path.append(os.path.join(parent, item)) + # parent = os.path.dirname(os.path.dirname(__file__)) + # sys.path.append(os.path.abspath(parent)) + # wd = os.getcwd() + # os.chdir(parent) + # os.system('%s setup.py test -q' % sys.executable) + # os.chdir(wd) + + # for item in os.listdir(parent): + # if item.endswith('.egg'): + # sys.path.append(os.path.join(parent, item)) html_theme_path = ['_themes'] html_theme = 'pyramid' -- cgit v1.2.3 From 48afc25e990eb875c8e605498b13876bffce417d Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Mon, 14 Oct 2013 16:50:50 +0200 Subject: Address #866; don't run the tests when the docs build, this means that 'make html' must be run using a SPHINXBUILD=/path/to/virtualenv/with/pyramid --- docs/conf.py | 11 ----------- 1 file changed, 11 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 490df48cc..a447c9968 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -150,17 +150,6 @@ if 'sphinx-build' in ' '.join(sys.argv): # protect against dumb importers sys.path.append(os.path.abspath('_themes')) - # parent = os.path.dirname(os.path.dirname(__file__)) - # sys.path.append(os.path.abspath(parent)) - # wd = os.getcwd() - # os.chdir(parent) - # os.system('%s setup.py test -q' % sys.executable) - # os.chdir(wd) - - # for item in os.listdir(parent): - # if item.endswith('.egg'): - # sys.path.append(os.path.join(parent, item)) - html_theme_path = ['_themes'] html_theme = 'pyramid' html_theme_options = dict( -- cgit v1.2.3