From 83549e631fe28e8e3b0b0274d0e631f1ebebd205 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Mon, 20 Jun 2011 01:31:27 -0400 Subject: prep for 1.1a1 --- 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 a610351ff..65cd35b94 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.1a0' +version = '1.1a1' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From cc85e7a96ccbb1671514adb1a1b1992fd1f02461 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Wed, 22 Jun 2011 19:39:45 -0400 Subject: prep for 1.1a2 --- 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 65cd35b94..34262191f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.1a1' +version = '1.1a2' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 1ba6fe34b9f37594d926cc63b6219ad61dbeebb6 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 26 Jun 2011 04:00:52 -0400 Subject: prep for 1.1a3 --- 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 34262191f..02f0339b5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.1a2' +version = '1.1a3' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 82ec1b881a61c94b6fb3066a2ac6b686eb0b2bd9 Mon Sep 17 00:00:00 2001 From: Blaise Laflamme Date: Sun, 26 Jun 2011 20:49:26 -0400 Subject: added github url option in docs conf for ribbon --- docs/conf.py | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 02f0339b5..86a92badd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -140,6 +140,10 @@ sys.path.append(os.path.abspath('_themes')) html_theme_path = ['_themes'] html_theme = 'pyramid' +html_theme_options = { + 'github_url': 'https://github.com/Pylons/pyramid' +} + # 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. -- cgit v1.2.3 From b9c0e79be2764b8f6c59e5be9044675666154ea0 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 1 Jul 2011 04:41:34 -0400 Subject: prep for 1.1a4 --- docs/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 86a92badd..f09cd63f5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.1a3' +version = '1.1a4' # The full version, including alpha/beta/rc tags. release = version @@ -456,7 +456,7 @@ def resig(app, what, name, obj, options, signature, return_annotation): # -- Options for Epub output --------------------------------------------------- # Bibliographic Dublin Core info. -epub_title = 'The Pyramid Web Application Development Framework, Version 1.0' +epub_title = 'The Pyramid Web Application Development Framework, Version 1.1' epub_author = 'Chris McDonough' epub_publisher = 'Agendaless Consulting' epub_copyright = '2008-2011' @@ -473,7 +473,7 @@ epub_scheme = 'ISBN' epub_identifier = '0615445675' # A unique identification for the text. -epub_uid = 'The Pyramid Web Application Development Framework, Version 1.0' +epub_uid = 'The Pyramid Web Application Development Framework, Version 1.1' # HTML files that should be inserted before the pages created by sphinx. # The format is a list of tuples containing the path and title. -- cgit v1.2.3 From a36fdbd40967117d34a70f156d2865aa2b21991e Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 10 Jul 2011 01:13:44 -0400 Subject: prep for 1.1b1 --- 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 f09cd63f5..31d816aff 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.1a4' +version = '1.1b1' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From d4ccb85f76f38400eaf90b40ccbc56b017e3a6bd Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Wed, 13 Jul 2011 03:34:05 -0400 Subject: prep for 1.1b2 --- 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 31d816aff..f0cf5fd53 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.1b1' +version = '1.1b2' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 999d44cf53e2213be8df881c2b407986b462c79c Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 15 Jul 2011 10:40:35 -0400 Subject: prep for 1.1b3 --- 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 f0cf5fd53..5c77e083b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.1b2' +version = '1.1b3' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 40c643e07e1a5eeb48e86070cd0ffbd998899669 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Mon, 18 Jul 2011 02:59:50 -0400 Subject: prep for 1.1b4 --- 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 5c77e083b..597090c42 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.1b3' +version = '1.1b4' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 8c03444dd5d80adaf65e30ebdabf1e6dde644965 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Thu, 21 Jul 2011 23:32:50 -0400 Subject: prep for 1.1; gather contributors --- 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 597090c42..5eacb257f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.1b4' +version = '1.1' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From c8c9cced044c03b376d1e3698668a65493d0d390 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 21 Aug 2011 00:24:34 -0400 Subject: bump conf.py version num --- docs/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 5eacb257f..f021f01a2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.1' +version = '1.2dev' # The full version, including alpha/beta/rc tags. release = version @@ -456,7 +456,7 @@ def resig(app, what, name, obj, options, signature, return_annotation): # -- Options for Epub output --------------------------------------------------- # Bibliographic Dublin Core info. -epub_title = 'The Pyramid Web Application Development Framework, Version 1.1' +epub_title = 'The Pyramid Web Application Development Framework, Version 1.2' epub_author = 'Chris McDonough' epub_publisher = 'Agendaless Consulting' epub_copyright = '2008-2011' @@ -473,7 +473,7 @@ epub_scheme = 'ISBN' epub_identifier = '0615445675' # A unique identification for the text. -epub_uid = 'The Pyramid Web Application Development Framework, Version 1.1' +epub_uid = 'The Pyramid Web Application Development Framework, Version 1.2' # HTML files that should be inserted before the pages created by sphinx. # The format is a list of tuples containing the path and title. -- cgit v1.2.3 From c1a179fbc713a8c8c5be19f8d327b8ced567d957 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Wed, 24 Aug 2011 00:29:42 -0400 Subject: prep for 1.2a1 --- 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 f021f01a2..23b88b949 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.2dev' +version = '1.2a1' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 5bee607f61614cd8d57e64eacd83c26cbb25a385 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sat, 27 Aug 2011 04:23:45 -0400 Subject: prep for 1.2a2 --- 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 23b88b949..22ae65a44 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.2a1' +version = '1.2a2' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 21a4c9b232b2d5c9660f27904b92645b109eda15 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Mon, 29 Aug 2011 11:46:41 -0400 Subject: prep for 1.2a3 --- 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 22ae65a44..d5c4301fb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.2a2' +version = '1.2a3' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From f1c6e093706f54c301655d9894c163afbb48ae1e Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 2 Sep 2011 12:52:53 -0400 Subject: prep for 1.2a4 --- 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 d5c4301fb..e350ca21f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.2a3' +version = '1.2a4' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 7961af6994ec744298debc5c4b62bce9b2d395ba Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 4 Sep 2011 01:40:44 -0400 Subject: prep for 1.2a5 --- 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 e350ca21f..735159aa4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.2a4' +version = '1.2a5' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From d00fa00e0ee116cce61f157b24b3924d38a352a5 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Tue, 6 Sep 2011 23:14:18 -0400 Subject: prep for 1.2a6 --- 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 735159aa4..a6e4f2239 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.2a5' +version = '1.2a6' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 9de21ff234ac7995a77d74f7da63b78a29ca1a56 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Thu, 8 Sep 2011 04:00:12 -0400 Subject: prep for 1.2b1 --- 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 a6e4f2239..cfbf6339f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.2a6' +version = '1.2b1' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From a66ae929a79a54f95a3786d9b95393a4fb8a8fc4 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Thu, 8 Sep 2011 17:45:20 -0400 Subject: Prep for 1.2b2; Closes #267 --- 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 cfbf6339f..4dad10a8c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.2b1' +version = '1.2b2' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 2cf1d0efe6d281bc2a0d8316af8480765200eeea Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 11 Sep 2011 01:30:37 -0400 Subject: prep for 1.2b3 --- 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 4dad10a8c..a35dfcfe8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.2b2' +version = '1.2b3' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 63f65dbfcb5e7ef7864f8a954849597ba07a0299 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Mon, 12 Sep 2011 23:16:37 -0400 Subject: prep for 1.2 --- 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 a35dfcfe8..71c4f58d4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.2b3' +version = '1.2' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 4ac7538f7808d1079695a1ebd6ca1c0bde647c37 Mon Sep 17 00:00:00 2001 From: michr Date: Fri, 23 Sep 2011 18:55:24 -0700 Subject: exclude book pages (foreword.rst, latexindex.rst, authorintro.rst) from online docs since they were generating warnings --- docs/conf.py | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 71c4f58d4..f32c3560a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -106,6 +106,10 @@ 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 = [] @@ -129,6 +133,11 @@ add_module_names = False if book: pygments_style = 'bw' +# do not include book material for online docs +if not book: + exclude_patterns.extend(['foreword.rst', 'latexindex.rst', + 'authorintro.rst']) + # The default language to highlight source code in. #highlight_language = 'guess' -- cgit v1.2.3 From 0822146013398357db4e75f26d9f07f5f7af94ad Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sat, 24 Sep 2011 04:00:51 -0400 Subject: not quite true --- docs/conf.py | 5 ----- 1 file changed, 5 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index f32c3560a..a5eaeb0fb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -133,11 +133,6 @@ add_module_names = False if book: pygments_style = 'bw' -# do not include book material for online docs -if not book: - exclude_patterns.extend(['foreword.rst', 'latexindex.rst', - 'authorintro.rst']) - # The default language to highlight source code in. #highlight_language = 'guess' -- cgit v1.2.3 From c8b363e547635e92a78c5718e9f17a5e8f55dc7f Mon Sep 17 00:00:00 2001 From: michr Date: Thu, 29 Sep 2011 02:03:33 -0700 Subject: avoid warning for latexindex, foreword by putting them in a hidden toc from now on complie docs strictly, turning warnings to errors exclude unnecssary static js files when compiling ePub --- docs/conf.py | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index a5eaeb0fb..c78285840 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -11,7 +11,8 @@ # All configuration values have a default value; values that are commented out # serve to show the default value. -import sys, os +import sys +import os import datetime import inspect import warnings @@ -389,7 +390,7 @@ def frontmatter(name, arguments, options, content, lineno, % reset page counter \setcounter{page}{1} % suppress first toc pagenum -\addtocontents{toc}{\protect\thispagestyle{empty}} +\addtocontents{toc}{\protect\thispagestyle{empty}} """, format='latex')] @@ -402,7 +403,7 @@ def mainmatter(name, arguments, options, content, lineno, % allow part/chapter/section numbering \setcounter{secnumdepth}{2} % get headers back -\pagestyle{fancy} +\pagestyle{fancy} \fancyhf{} \renewcommand{\headrulewidth}{0.5pt} \renewcommand{\footrulewidth}{0pt} @@ -488,7 +489,10 @@ epub_uid = 'The Pyramid Web Application Development Framework, Version 1.2' #epub_post_files = [] # A list of files that should not be packed into the epub file. -#epub_exclude_files = [] +epub_exclude_files = ['_static/opensearch.xml', '_static/doctools.js', + '_static/jquery.js', '_static/searchtools.js', '_static/underscore.js', + '_static/basic.css', 'search.html'] + # The depth of the table of contents in toc.ncx. epub_tocdepth = 3 -- cgit v1.2.3 From bb18ff68d0607b1b4a088d56b3df5696eb37f146 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Mon, 21 Nov 2011 09:27:53 -0500 Subject: vb --- 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 c78285840..20236842b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -94,7 +94,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.2' +version = '1.3dev' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 11129ca073b4926037368d9a0bf079dc422e28f7 Mon Sep 17 00:00:00 2001 From: Blaise Laflamme Date: Sat, 26 Nov 2011 18:30:21 -0500 Subject: updated current docs to use in progress badge --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index c78285840..f97ad1547 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -147,6 +147,7 @@ html_theme = 'pyramid' html_theme_options = { '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 -- cgit v1.2.3 From a3a2186ab501f68de43c76d7d30194169360dc0e Mon Sep 17 00:00:00 2001 From: Blaise Laflamme Date: Sat, 26 Nov 2011 19:17:51 -0500 Subject: =?UTF-8?q?gardening=E2=80=A6=20dumb=20me=20:(?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 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 4010cf111..895f80344 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -146,7 +146,7 @@ html_theme_path = ['_themes'] html_theme = 'pyramid' html_theme_options = { - 'github_url': 'https://github.com/Pylons/pyramid' + 'github_url': 'https://github.com/Pylons/pyramid', 'in_progress': True } -- cgit v1.2.3 From ecf7a2b8ec62c542aed17558d2525f495a72ae3b Mon Sep 17 00:00:00 2001 From: Blaise Laflamme Date: Sat, 26 Nov 2011 20:02:56 -0500 Subject: attempted to fix theme update for rtd --- docs/conf.py | 3 +++ 1 file changed, 3 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 895f80344..e37e758ce 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -38,6 +38,7 @@ LaTeXTranslator.visit_inline = nothing LaTeXTranslator.depart_inline = nothing book = os.environ.get('BOOK') +rtd = os.environ.get('READTHEDOCS', None) == 'True' # If your extensions are in another directory, add it here. If the directory # is relative to the documentation root, use os.path.abspath to make it @@ -47,6 +48,8 @@ sys.path.append(os.path.abspath(parent)) wd = os.getcwd() os.chdir(parent) os.system('%s setup.py test -q' % sys.executable) +if rtd: + os.system('git submodule update --init') os.chdir(wd) for item in os.listdir(parent): -- cgit v1.2.3 From ecf932c51b8f279199c68fc4925a2cdd0b0671a7 Mon Sep 17 00:00:00 2001 From: Blaise Laflamme Date: Sat, 26 Nov 2011 21:12:53 -0500 Subject: fix for themes on rtd --- docs/conf.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index e37e758ce..39b6e7a04 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -49,7 +49,10 @@ wd = os.getcwd() os.chdir(parent) os.system('%s setup.py test -q' % sys.executable) if rtd: - os.system('git submodule update --init') + from subprocess import Popen, PIPE + p = subprocess.Popen('which git', shell=True, stdout=subprocess.PIPE) + git = p.stdout.read().strip() + os.system('rm -Rf docs/_themes; {0} submodule update --init'.format(git)) os.chdir(wd) for item in os.listdir(parent): -- cgit v1.2.3 From 9016fe3416407481176df2360335affc15d6255c Mon Sep 17 00:00:00 2001 From: Blaise Laflamme Date: Sat, 26 Nov 2011 21:14:53 -0500 Subject: garden --- 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 39b6e7a04..97294d245 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -50,7 +50,7 @@ os.chdir(parent) os.system('%s setup.py test -q' % sys.executable) if rtd: from subprocess import Popen, PIPE - p = subprocess.Popen('which git', shell=True, stdout=subprocess.PIPE) + p = subprocess.Popen('which git', shell=True, stdout=PIPE) git = p.stdout.read().strip() os.system('rm -Rf docs/_themes; {0} submodule update --init'.format(git)) os.chdir(wd) -- cgit v1.2.3 From 6a10cd1156095bec367d89d8c13b6a11a5f8c254 Mon Sep 17 00:00:00 2001 From: Blaise Laflamme Date: Sat, 26 Nov 2011 21:16:41 -0500 Subject: =?UTF-8?q?garden=E2=80=A6=20time=20for=20me=20to=20get=20some=20r?= =?UTF-8?q?est=20I=20think=20:(?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 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 97294d245..f751c32e6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -50,7 +50,7 @@ os.chdir(parent) os.system('%s setup.py test -q' % sys.executable) if rtd: from subprocess import Popen, PIPE - p = subprocess.Popen('which git', shell=True, stdout=PIPE) + p = Popen('which git', shell=True, stdout=PIPE) git = p.stdout.read().strip() os.system('rm -Rf docs/_themes; {0} submodule update --init'.format(git)) os.chdir(wd) -- cgit v1.2.3 From afe7a786bd2a75b7c9d36f58856b72b6978ef617 Mon Sep 17 00:00:00 2001 From: Blaise Laflamme Date: Sat, 26 Nov 2011 22:27:43 -0500 Subject: work around for submodule not updating to latest commit --- 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 f751c32e6..874425808 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -52,7 +52,7 @@ if rtd: from subprocess import Popen, PIPE p = Popen('which git', shell=True, stdout=PIPE) git = p.stdout.read().strip() - os.system('rm -Rf docs/_themes; {0} submodule update --init'.format(git)) + os.system('{0} submodule update --init; {0} foreach git pull origin master'.format(git)) os.chdir(wd) for item in os.listdir(parent): -- cgit v1.2.3 From 9396b476bab8a2fb885c65791b2150d74ceac122 Mon Sep 17 00:00:00 2001 From: Blaise Laflamme Date: Sat, 26 Nov 2011 22:35:48 -0500 Subject: git submodule missing --- 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 874425808..4a39f5d64 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -52,7 +52,7 @@ if rtd: from subprocess import Popen, PIPE p = Popen('which git', shell=True, stdout=PIPE) git = p.stdout.read().strip() - os.system('{0} submodule update --init; {0} foreach git pull origin master'.format(git)) + os.system('{0} submodule update --init; {0} submodule foreach git pull origin master;'.format(git)) os.chdir(wd) for item in os.listdir(parent): -- cgit v1.2.3 From d0a25788fca2d2ebbf008658401e0d64ae232a8d Mon Sep 17 00:00:00 2001 From: Blaise Laflamme Date: Sun, 27 Nov 2011 12:33:27 -0500 Subject: updated doc theme workflow --- docs/conf.py | 32 ++++++++++++++++++++------------ 1 file changed, 20 insertions(+), 12 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 4a39f5d64..6443ed17e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -38,7 +38,6 @@ LaTeXTranslator.visit_inline = nothing LaTeXTranslator.depart_inline = nothing book = os.environ.get('BOOK') -rtd = os.environ.get('READTHEDOCS', None) == 'True' # If your extensions are in another directory, add it here. If the directory # is relative to the documentation root, use os.path.abspath to make it @@ -48,11 +47,6 @@ sys.path.append(os.path.abspath(parent)) wd = os.getcwd() os.chdir(parent) os.system('%s setup.py test -q' % sys.executable) -if rtd: - from subprocess import Popen, PIPE - p = Popen('which git', shell=True, stdout=PIPE) - git = p.stdout.read().strip() - os.system('{0} submodule update --init; {0} submodule foreach git pull origin master;'.format(git)) os.chdir(wd) for item in os.listdir(parent): @@ -147,15 +141,29 @@ if book: # ----------------------- # Add and use Pylons theme +from subprocess import call, Popen, PIPE + +p = Popen('which git', shell=True, stdout=PIPE) +git = p.stdout.read().strip() +cwd = os.getcwd() +_themes = os.path.join(cwd, '_themes') + +if not os.path.isdir(_themes): + call(['git', 'clone', 'git://github.com/Pylons/pylons_sphinx_theme.git', + '_themes']) +else: + os.chdir(_themes) + call(['git', 'checkout', 'master']) + call(['git', 'pull']) + os.chdir(cwd) + sys.path.append(os.path.abspath('_themes')) html_theme_path = ['_themes'] html_theme = 'pyramid' - -html_theme_options = { - 'github_url': 'https://github.com/Pylons/pyramid', - 'in_progress': True -} - +html_theme_options = dict( + github_url='https://github.com/Pylons/pyramid_tutorials', + 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. -- cgit v1.2.3 From 862a265e9274239ca835745dea8c5bc4b42910f2 Mon Sep 17 00:00:00 2001 From: Blaise Laflamme Date: Sun, 27 Nov 2011 12:41:50 -0500 Subject: fixed github 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 6443ed17e..b40d3f08d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -161,7 +161,7 @@ sys.path.append(os.path.abspath('_themes')) html_theme_path = ['_themes'] html_theme = 'pyramid' html_theme_options = dict( - github_url='https://github.com/Pylons/pyramid_tutorials', + 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 -- cgit v1.2.3 From 480df1f5227d5beda988431ea7588241338ff54f Mon Sep 17 00:00:00 2001 From: Blaise Laflamme Date: Sun, 27 Nov 2011 12:55:28 -0500 Subject: fixed version number --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index b40d3f08d..092c1fca3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -476,7 +476,7 @@ def resig(app, what, name, obj, options, signature, return_annotation): # -- Options for Epub output --------------------------------------------------- # Bibliographic Dublin Core info. -epub_title = 'The Pyramid Web Application Development Framework, Version 1.2' +epub_title = 'The Pyramid Web Application Development Framework, Version 1.3dev' epub_author = 'Chris McDonough' epub_publisher = 'Agendaless Consulting' epub_copyright = '2008-2011' @@ -493,7 +493,7 @@ epub_scheme = 'ISBN' epub_identifier = '0615445675' # A unique identification for the text. -epub_uid = 'The Pyramid Web Application Development Framework, Version 1.2' +epub_uid = 'The Pyramid Web Application Development Framework, Version 1.3dev' # HTML files that should be inserted before the pages created by sphinx. # The format is a list of tuples containing the path and title. -- cgit v1.2.3 From fd685bae73933434b4c4fd0689898407fd4f9058 Mon Sep 17 00:00:00 2001 From: Blaise Laflamme Date: Sun, 27 Nov 2011 13:14:40 -0500 Subject: fixed git ref --- docs/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 092c1fca3..530703e14 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -149,12 +149,12 @@ cwd = os.getcwd() _themes = os.path.join(cwd, '_themes') if not os.path.isdir(_themes): - call(['git', 'clone', 'git://github.com/Pylons/pylons_sphinx_theme.git', + call([git, 'clone', 'git://github.com/Pylons/pylons_sphinx_theme.git', '_themes']) else: os.chdir(_themes) - call(['git', 'checkout', 'master']) - call(['git', 'pull']) + call([git, 'checkout', 'master']) + call([git, 'pull']) os.chdir(cwd) sys.path.append(os.path.abspath('_themes')) -- cgit v1.2.3 From 06f12ac4c5c2ae2027aac5bb873f7b01c4dee2e3 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 9 Dec 2011 04:18:16 -0500 Subject: try to protect against shell commands being invoked if imported during installation --- docs/conf.py | 61 ++++++++++++++++++++++++++++++------------------------------ 1 file changed, 30 insertions(+), 31 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 530703e14..e0954f19a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -39,20 +39,6 @@ LaTeXTranslator.depart_inline = nothing book = os.environ.get('BOOK') -# If your extensions are in another directory, add it here. If the directory -# is relative to the documentation root, use os.path.abspath to make it -# absolute, like shown here. -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)) - # General configuration # --------------------- @@ -141,23 +127,36 @@ if book: # ----------------------- # Add and use Pylons theme -from subprocess import call, Popen, PIPE - -p = Popen('which git', shell=True, stdout=PIPE) -git = p.stdout.read().strip() -cwd = os.getcwd() -_themes = os.path.join(cwd, '_themes') - -if not os.path.isdir(_themes): - call([git, 'clone', 'git://github.com/Pylons/pylons_sphinx_theme.git', - '_themes']) -else: - os.chdir(_themes) - call([git, 'checkout', 'master']) - call([git, 'pull']) - os.chdir(cwd) - -sys.path.append(os.path.abspath('_themes')) +if 'sphinx-build' in ' '.join(sys.argv): # protect against dumb importers + from subprocess import call, Popen, PIPE + + p = Popen('which git', shell=True, stdout=PIPE) + git = p.stdout.read().strip() + cwd = os.getcwd() + _themes = os.path.join(cwd, '_themes') + + if not os.path.isdir(_themes): + call([git, 'clone', 'git://github.com/Pylons/pylons_sphinx_theme.git', + '_themes']) + else: + os.chdir(_themes) + call([git, 'checkout', 'master']) + call([git, 'pull']) + os.chdir(cwd) + + 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 From 7e2ed7a57fb09ad04e8a807a88f048c2b5c60351 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 9 Dec 2011 04:57:09 -0500 Subject: remove risky tag --- 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 e0954f19a..d55f14845 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -161,7 +161,7 @@ html_theme_path = ['_themes'] html_theme = 'pyramid' html_theme_options = dict( github_url='https://github.com/Pylons/pyramid', - in_progress='true' +# 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 -- cgit v1.2.3 From 4fd5ec74ce73cee2abd3b366252036214fe65645 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 9 Dec 2011 12:39:51 -0500 Subject: move master to 1.4dev --- docs/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index e0954f19a..b6986774b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -80,7 +80,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.3dev' +version = '1.4dev' # The full version, including alpha/beta/rc tags. release = version @@ -475,7 +475,7 @@ def resig(app, what, name, obj, options, signature, return_annotation): # -- Options for Epub output --------------------------------------------------- # Bibliographic Dublin Core info. -epub_title = 'The Pyramid Web Application Development Framework, Version 1.3dev' +epub_title = 'The Pyramid Web Application Development Framework, Version 1.4dev' epub_author = 'Chris McDonough' epub_publisher = 'Agendaless Consulting' epub_copyright = '2008-2011' @@ -492,7 +492,7 @@ epub_scheme = 'ISBN' epub_identifier = '0615445675' # A unique identification for the text. -epub_uid = 'The Pyramid Web Application Development Framework, Version 1.3dev' +epub_uid = 'The Pyramid Web Application Development Framework, Version 1.4dev' # HTML files that should be inserted before the pages created by sphinx. # The format is a list of tuples containing the path and title. -- cgit v1.2.3 From 5f1cf3fbc519085b93fb16a230c0637050ce350d Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 9 Dec 2011 15:04:49 -0500 Subject: prep for 1.3a1 --- docs/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index d55f14845..f913b2462 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -80,7 +80,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.3dev' +version = '1.3a1' # The full version, including alpha/beta/rc tags. release = version @@ -475,7 +475,7 @@ def resig(app, what, name, obj, options, signature, return_annotation): # -- Options for Epub output --------------------------------------------------- # Bibliographic Dublin Core info. -epub_title = 'The Pyramid Web Application Development Framework, Version 1.3dev' +epub_title = 'The Pyramid Web Application Development Framework, Version 1.3' epub_author = 'Chris McDonough' epub_publisher = 'Agendaless Consulting' epub_copyright = '2008-2011' @@ -492,7 +492,7 @@ epub_scheme = 'ISBN' epub_identifier = '0615445675' # A unique identification for the text. -epub_uid = 'The Pyramid Web Application Development Framework, Version 1.3dev' +epub_uid = 'The Pyramid Web Application Development Framework, Version 1.3' # HTML files that should be inserted before the pages created by sphinx. # The format is a list of tuples containing the path and title. -- cgit v1.2.3 From 9dce50a3bdd30b7c5c9b8efd184bad7cbbb1a030 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Wed, 14 Dec 2011 09:23:22 -0500 Subject: prep for 1.3a2 --- 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 f913b2462..79543777d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -80,7 +80,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.3a1' +version = '1.3a2' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From d394da5175fece8388f2fc0dfd906942faa6f2ed Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Wed, 21 Dec 2011 02:18:37 -0500 Subject: prep for 1.3a3 --- 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 5281017e7..39006f1bb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -80,7 +80,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.3a2' +version = '1.3a3' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 683941663033bbac588b9ac8f1ff28eeefc511c9 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Thu, 5 Jan 2012 09:21:55 -0500 Subject: prep for 1.3a4 --- 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 39006f1bb..4e0ffff55 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -80,7 +80,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.3a3' +version = '1.3a4' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From cf3a11e990adda800e284effb006f1c28335da4d Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Mon, 9 Jan 2012 03:49:46 -0500 Subject: prep for 1.3a5 --- 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 4e0ffff55..2ab56cadf 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -80,7 +80,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.3a4' +version = '1.3a5' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From a41c8ca521ba983594364b1eb1f6c6025149fbe7 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 20 Jan 2012 10:53:55 -0500 Subject: prep for 1.3a6 --- 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 2ab56cadf..3496bd38c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -80,7 +80,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.3a5' +version = '1.3a6' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From e3f9d0e6ea3c98699de7b60bc3900b1a40fcba19 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Wed, 8 Feb 2012 00:05:31 -0500 Subject: prep for 1.3a7 --- 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 3496bd38c..0c56f56e7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -80,7 +80,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.3a6' +version = '1.3a7' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 51919e05d9c251f7f80a4736be2b822eafc5d189 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 19 Feb 2012 17:54:27 -0500 Subject: prep for 1.3a8 --- 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 0c56f56e7..3e38226c1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -80,7 +80,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.3a7' +version = '1.3a8' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 662d6ea96a79cdd9943a9e3c871fe07282ee671c Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Wed, 22 Feb 2012 21:10:08 -0500 Subject: prep for 1.3a9 --- 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 3e38226c1..79d9946ad 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -80,7 +80,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.3a8' +version = '1.3a9' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From cf973d67fcae67f517d407a3f1bc3cb191def5b6 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 26 Feb 2012 15:59:20 -0500 Subject: prep for 1.3b1 --- 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 79d9946ad..187b1a125 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -80,7 +80,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.3a9' +version = '1.3b1' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 3a14206e0f03fe24fa9a6611097230607332184d Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 2 Mar 2012 03:11:22 -0500 Subject: prep for 1.3b2 --- 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 187b1a125..1c957162e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -80,7 +80,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.3b1' +version = '1.3b2' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 58d14988ca00ceda3764970a041f7e8c1d9b8501 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sat, 17 Mar 2012 17:49:42 -0400 Subject: prep for 1.3b3 --- 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 1c957162e..d694b2151 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -80,7 +80,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.3b2' +version = '1.3b3' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 7c88fec67a3c3edd33ef44dc0ad0c55fb672b7e1 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Wed, 21 Mar 2012 03:46:00 -0400 Subject: prep for 1.3 --- 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 d694b2151..5254561ba 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -80,7 +80,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.3b3' +version = '1.3' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From abcfa5c11be5ab62af10d6837ac7d06ef418df17 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Thu, 29 Mar 2012 04:23:21 -0400 Subject: update version markers --- 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 5254561ba..ffbf15808 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -80,7 +80,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.3' +version = '1.4dev' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 9cddb399453d9cde6c03dff8a631f8f1977348a6 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Tue, 10 Apr 2012 18:53:07 -0400 Subject: test checkin for rtd --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index ffbf15808..1c24a0ead 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -476,7 +476,7 @@ def resig(app, what, name, obj, options, signature, return_annotation): # -- Options for Epub output --------------------------------------------------- # Bibliographic Dublin Core info. -epub_title = 'The Pyramid Web Application Development Framework, Version 1.3' +epub_title = 'The Pyramid Web Application Development Framework, Version 1.4' epub_author = 'Chris McDonough' epub_publisher = 'Agendaless Consulting' epub_copyright = '2008-2011' @@ -493,7 +493,7 @@ epub_scheme = 'ISBN' epub_identifier = '0615445675' # A unique identification for the text. -epub_uid = 'The Pyramid Web Application Development Framework, Version 1.3' +epub_uid = 'The Pyramid Web Application Development Framework, Version 1.4' # HTML files that should be inserted before the pages created by sphinx. # The format is a list of tuples containing the path and title. -- cgit v1.2.3 From 55747c9487422222f963ba843fdbeb3afc2df74e Mon Sep 17 00:00:00 2001 From: Michael Merickel Date: Tue, 10 Apr 2012 18:58:39 -0500 Subject: enable warning badge on master docs --- 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 1c24a0ead..db972261d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -162,7 +162,7 @@ html_theme_path = ['_themes'] html_theme = 'pyramid' html_theme_options = dict( github_url='https://github.com/Pylons/pyramid', -# in_progress='true' + 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 -- cgit v1.2.3 From eba3b0763cf4fa3aa4b099adb2e10c53c6d99e74 Mon Sep 17 00:00:00 2001 From: Blaise Laflamme Date: Sun, 6 May 2012 19:56:21 -0400 Subject: added sphinx theme as submodule, added rtd hack to update theme --- docs/conf.py | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index db972261d..fc3d184ed 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -132,18 +132,15 @@ if 'sphinx-build' in ' '.join(sys.argv): # protect against dumb importers from subprocess import call, Popen, PIPE p = Popen('which git', shell=True, stdout=PIPE) - git = p.stdout.read().strip() + cwd = os.getcwd() _themes = os.path.join(cwd, '_themes') - - if not os.path.isdir(_themes): - call([git, 'clone', 'git://github.com/Pylons/pylons_sphinx_theme.git', - '_themes']) + p = Popen('which git', shell=True, stdout=PIPE) + git = p.stdout.read().strip() + if not os.listdir(_themes): + call([git, 'submodule', '--init']) else: - os.chdir(_themes) - call([git, 'checkout', 'master']) - call([git, 'pull']) - os.chdir(cwd) + call([git, 'submodule', 'update']) sys.path.append(os.path.abspath('_themes')) -- cgit v1.2.3 From 25f3e44681459deff685b7b5c769d98f21532704 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Wed, 9 May 2012 09:31:23 -0400 Subject: activate sphinx.ext.viewcode extension --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index db972261d..21843933c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,6 +48,7 @@ extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.doctest', 'repoze.sphinx.autointerface', + 'sphinx.ext.viewcode', # 'sphinx.ext.intersphinx' ] -- cgit v1.2.3 From ce1e86c44e812ae438c2647cd7d5b6a4ce2ab478 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 16 Sep 2012 23:15:45 -0400 Subject: prep for 1.4a1 --- 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 80ee0d2e5..65d1cb83b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -81,7 +81,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.4dev' +version = '1.4a1' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 2389c332c63d0fedf5b65d45b0db55cb9c601818 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 16 Sep 2012 23:37:14 -0400 Subject: no longer in progress --- 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 65d1cb83b..7abae7a85 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -160,7 +160,7 @@ html_theme_path = ['_themes'] html_theme = 'pyramid' html_theme_options = dict( github_url='https://github.com/Pylons/pyramid', - in_progress='true', +# 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 -- cgit v1.2.3 From 072cbf7ae84e80185ebc122d0c11a6838ac36093 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Thu, 27 Sep 2012 11:40:57 -0400 Subject: prep for 1.4a2 --- 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 7abae7a85..337b1d8bf 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -81,7 +81,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.4a1' +version = '1.4a2' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 4a6cca62ddf33580b1de210ef5ca54bfb2769243 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 26 Oct 2012 01:48:24 -0400 Subject: prep for 1.4a3 --- 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 337b1d8bf..9bda4c798 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -81,7 +81,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.4a2' +version = '1.4a3' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 948068688561806a321a17bfc15c87446a577b5b Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Wed, 14 Nov 2012 02:49:16 -0500 Subject: prep for release --- 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 9bda4c798..5e17de18a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -81,7 +81,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.4a3' +version = '1.4a4' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 1608b26c9d3967d258613f038ff8b5f258a4a698 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Wed, 21 Nov 2012 23:19:43 -0500 Subject: prep for 1.4b1 --- 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 5e17de18a..3dc09d95d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -81,7 +81,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.4a4' +version = '1.4b1' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From a7e0e601df4e093ebd2fdd7b53bd0bbb9e8d7ce5 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Mon, 10 Dec 2012 15:46:57 -0500 Subject: prep for 1.4b2 --- 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 3dc09d95d..63f3a2790 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -81,7 +81,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.4b1' +version = '1.4b2' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From e609e19d028b1d714439188812ca3c9811e0a508 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Mon, 10 Dec 2012 21:42:18 -0500 Subject: prep for 1.4b3 --- 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 63f3a2790..0034f4286 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -81,7 +81,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.4b2' +version = '1.4b3' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 96ab9f26990423f67045e5639a29579a1a76a71e Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Tue, 18 Dec 2012 03:00:29 -0500 Subject: prep for 1.4 --- 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 0034f4286..abb8bdd2e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -81,7 +81,7 @@ copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year # other places throughout the built documents. # # The short X.Y version. -version = '1.4b3' +version = '1.4' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 7673b06209888e2837a135d0c51f6918b94cb70b Mon Sep 17 00:00:00 2001 From: "Lorenzo M. Catucci" Date: Fri, 4 Jan 2013 15:42:34 +0100 Subject: Fix pdf document generation by making sphinx aware about the images referenced in the latex preamble. --- docs/conf.py | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index abb8bdd2e..3dc72d8ae 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -235,6 +235,8 @@ latex_paper_size = 'letter' # The font size ('10pt', '11pt' or '12pt'). latex_font_size = '10pt' +latex_additional_files = ['_static/latex-note.png', '_static/latex-warning.png'] + # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, document class [howto/manual]). latex_documents = [ -- cgit v1.2.3 From 09f43d3ba25ba2189a1b9abf6978e14690034d16 Mon Sep 17 00:00:00 2001 From: Goodwill Coding Date: Sat, 5 Jan 2013 10:23:35 -0800 Subject: fix up sphinx config: - make sure the versioning in title, uid is done automatically - automatically generate copyright years - excluded additional .js files that were stopping epub from generating correctly - also adjust the remake script to use env not env27 --- docs/conf.py | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 3dc72d8ae..048b7ce78 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -26,6 +26,7 @@ from sphinx.writers.latex import LaTeXTranslator from docutils import nodes from docutils import utils + def raw(*arg): raise nodes.SkipNode TextTranslator.visit_raw = raw @@ -97,7 +98,7 @@ 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 = ['_themes/README.rst',] +exclude_patterns = ['_themes/README.rst', ] # List of directories, relative to source directories, that shouldn't be searched # for source files. @@ -129,14 +130,12 @@ if book: # ----------------------- # Add and use Pylons theme -if 'sphinx-build' in ' '.join(sys.argv): # protect against dumb importers +if 'sphinx-build' in ' '.join(sys.argv): # protect against dumb importers from subprocess import call, Popen, PIPE p = Popen('which git', shell=True, stdout=PIPE) - cwd = os.getcwd() _themes = os.path.join(cwd, '_themes') - p = Popen('which git', shell=True, stdout=PIPE) git = p.stdout.read().strip() if not os.listdir(_themes): call([git, 'submodule', '--init']) @@ -373,10 +372,10 @@ _PREAMBLE = r""" latex_elements = { 'preamble': _PREAMBLE, - 'wrapperclass':'book', - 'date':'', - 'releasename':'Version', - 'title':r'The Pyramid Web Application \newline Development Framework', + 'wrapperclass': 'book', + 'date': '', + 'releasename': 'Version', + 'title': r'The Pyramid Web Application \newline Development Framework', # 'pointsize':'12pt', # uncomment for 12pt version } @@ -392,6 +391,7 @@ latex_elements = { #paragraph 4 #subparagraph 5 + def frontmatter(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine): return [nodes.raw( @@ -409,6 +409,7 @@ def frontmatter(name, arguments, options, content, lineno, """, format='latex')] + def mainmatter(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine): return [nodes.raw( @@ -428,11 +429,13 @@ def mainmatter(name, arguments, options, content, lineno, """, format='latex')] + def backmatter(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine): return [nodes.raw('', '\\backmatter\n\\setcounter{secnumdepth}{-1}\n', format='latex')] + def app_role(role, rawtext, text, lineno, inliner, options={}, content=[]): """custom role for :app: marker, does nothing in particular except allow :app:`Pyramid` to work (for later search and replace).""" @@ -450,6 +453,7 @@ def setup(app): app.add_directive('backmatter', backmatter, 1, (0, 0, 0)) app.connect('autodoc-process-signature', resig) + def resig(app, what, name, obj, options, signature, return_annotation): """ Allow for preservation of ``@action_method`` decorated methods in configurator """ @@ -476,10 +480,11 @@ def resig(app, what, name, obj, options, signature, return_annotation): # -- Options for Epub output --------------------------------------------------- # Bibliographic Dublin Core info. -epub_title = 'The Pyramid Web Application Development Framework, Version 1.4' +epub_title = 'The Pyramid Web Application Development Framework, Version %s' \ + % release epub_author = 'Chris McDonough' epub_publisher = 'Agendaless Consulting' -epub_copyright = '2008-2011' +epub_copyright = '2008-%d' % datetime.datetime.now().year # The language of the text. It defaults to the language option # or en if the language is not set. @@ -493,8 +498,8 @@ epub_scheme = 'ISBN' epub_identifier = '0615445675' # A unique identification for the text. -epub_uid = 'The Pyramid Web Application Development Framework, Version 1.4' - +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 = [] @@ -506,7 +511,7 @@ epub_uid = 'The Pyramid Web Application Development Framework, Version 1.4' # A list of files that should not be packed into the epub file. epub_exclude_files = ['_static/opensearch.xml', '_static/doctools.js', '_static/jquery.js', '_static/searchtools.js', '_static/underscore.js', - '_static/basic.css', 'search.html'] + '_static/basic.css', 'search.html', '_static/websupport.js'] # The depth of the table of contents in toc.ncx. -- cgit v1.2.3 From 3604e6edbf7f9aac375ca3b2a9914c5665a0cf8d Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Sat, 12 Jan 2013 09:51:08 +0200 Subject: Pyramid copyright is from 2008 52d4fbc mistakenly removed '2008' in '2008-' --- docs/conf.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 048b7ce78..6eb76af9d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -76,7 +76,8 @@ master_doc = 'index' # General substitutions. project = 'The Pyramid Web Application Development Framework' -copyright = '%s, Agendaless Consulting' % datetime.datetime.now().year +thisyear = datetime.datetime.now().year +copyright = '2008-%s, Agendaless Consulting' % thisyear # The default replacements for |version| and |release|, also used in various # other places throughout the built documents. @@ -484,7 +485,7 @@ epub_title = 'The Pyramid Web Application Development Framework, Version %s' \ % release epub_author = 'Chris McDonough' epub_publisher = 'Agendaless Consulting' -epub_copyright = '2008-%d' % datetime.datetime.now().year +epub_copyright = '2008-%d' % thisyear # The language of the text. It defaults to the language option # or en if the language is not set. -- cgit v1.2.3 From 182686ca798806a16b4d18e8bae49d5139477428 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Sun, 10 Feb 2013 13:29:53 +0200 Subject: bring back the intershinx goodness This ensures that links to external objects are 'magically' generated. This feature was disable in commit 288072c, but it was likely not used at the time. --- docs/conf.py | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 6eb76af9d..192bd7a79 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -50,20 +50,20 @@ extensions = [ 'sphinx.ext.doctest', 'repoze.sphinx.autointerface', 'sphinx.ext.viewcode', -# 'sphinx.ext.intersphinx' + 'sphinx.ext.intersphinx' ] -# Looks for objects in other Pyramid projects -## intersphinx_mapping = { -## 'cookbook': -## ('http://docs.pylonsproject.org/projects/pyramid_cookbook/dev/', None), -## 'handlers': -## ('http://docs.pylonsproject.org/projects/pyramid_handlers/dev/', None), -## 'zcml': -## ('http://docs.pylonsproject.org/projects/pyramid_zcml/dev/', None), -## 'jinja2': -## ('http://docs.pylonsproject.org/projects/pyramid_jinja2/dev/', None), -## } +# Looks for objects in external projects +intersphinx_mapping = { + 'who': ('http://docs.repoze.org/who/2.0', None), + 'python': ('http://docs.python.org', None), + 'python3': ('http://docs.python.org/3', None), + 'tstring': + ('http://docs.pylonsproject.org/projects/translationstring/en/latest', + None), + 'venusian': + ('http://docs.pylonsproject.org/projects/venusian/en/latest', None), +} # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] -- cgit v1.2.3 From 179f8c3e5c96ebef06710a0c214409aadd94ada5 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Sun, 10 Feb 2013 14:48:55 +0200 Subject: spaces are preferred to tabs --- 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 192bd7a79..8d22d4d42 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -62,7 +62,7 @@ intersphinx_mapping = { ('http://docs.pylonsproject.org/projects/translationstring/en/latest', None), 'venusian': - ('http://docs.pylonsproject.org/projects/venusian/en/latest', None), + ('http://docs.pylonsproject.org/projects/venusian/en/latest', None), } # Add any paths that contain templates here, relative to this directory. -- cgit v1.2.3 From f1c29f104a14dea0be612ca0aa8ecd49e165fafa Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Thu, 21 Mar 2013 18:24:31 +0200 Subject: add hyperlinks for SQLAlchemy --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 8d22d4d42..b763267dd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -55,6 +55,7 @@ extensions = [ # Looks for objects in external projects intersphinx_mapping = { + 'sqla': ('http://docs.sqlalchemy.org/en/rel_0_8/', None), 'who': ('http://docs.repoze.org/who/2.0', None), 'python': ('http://docs.python.org', None), 'python3': ('http://docs.python.org/3', None), -- cgit v1.2.3 From 39b8a29a48d716b3381596fe71cddf6c59393518 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Thu, 21 Mar 2013 18:37:28 +0200 Subject: use version-agnostic link, to avoid maintenance --- 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 b763267dd..d1a882389 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -55,7 +55,7 @@ extensions = [ # Looks for objects in external projects intersphinx_mapping = { - 'sqla': ('http://docs.sqlalchemy.org/en/rel_0_8/', None), + 'sqla': ('http://docs.sqlalchemy.org/en/latest', None), 'who': ('http://docs.repoze.org/who/2.0', None), 'python': ('http://docs.python.org', None), 'python3': ('http://docs.python.org/3', None), -- cgit v1.2.3 From 2a65f2086ce5b0c2f029fbc0ea165a65cd601ec3 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Thu, 21 Mar 2013 18:52:07 +0200 Subject: four spaces is standard --- docs/conf.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index d1a882389..89eb998e7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -55,14 +55,14 @@ extensions = [ # Looks for objects in external projects intersphinx_mapping = { - 'sqla': ('http://docs.sqlalchemy.org/en/latest', None), - 'who': ('http://docs.repoze.org/who/2.0', None), - 'python': ('http://docs.python.org', None), - 'python3': ('http://docs.python.org/3', None), - 'tstring': + 'sqla': ('http://docs.sqlalchemy.org/en/latest', None), + 'who': ('http://docs.repoze.org/who/2.0', None), + 'python': ('http://docs.python.org', None), + 'python3': ('http://docs.python.org/3', None), + 'tstring': ('http://docs.pylonsproject.org/projects/translationstring/en/latest', None), - 'venusian': + 'venusian': ('http://docs.pylonsproject.org/projects/venusian/en/latest', None), } -- cgit v1.2.3 From 09bca9c5ed0e66699762d66b09be899e86967899 Mon Sep 17 00:00:00 2001 From: Michael Merickel Date: Thu, 21 Mar 2013 12:40:02 -0500 Subject: update repoze.who to latest symlink --- 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 89eb998e7..eff6db488 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -56,7 +56,7 @@ extensions = [ # Looks for objects in external projects intersphinx_mapping = { 'sqla': ('http://docs.sqlalchemy.org/en/latest', None), - 'who': ('http://docs.repoze.org/who/2.0', None), + 'who': ('http://docs.repoze.org/who/latest', None), 'python': ('http://docs.python.org', None), 'python3': ('http://docs.python.org/3', None), 'tstring': -- cgit v1.2.3 From 1dcb8a49933cb98109c6524220089cabe81e355e Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Sun, 24 Mar 2013 08:15:18 +0200 Subject: add webob to intersphinx list With this change, we get hyperlinks for webob cross-references. --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index eff6db488..69d00cdaa 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -55,6 +55,7 @@ extensions = [ # Looks for objects in external projects intersphinx_mapping = { + 'webob': ('http://docs.webob.org/en/latest', None), 'sqla': ('http://docs.sqlalchemy.org/en/latest', None), 'who': ('http://docs.repoze.org/who/latest', None), 'python': ('http://docs.python.org', None), -- cgit v1.2.3 From c2837c9f05304f685bde4baa4814f304d4aa67ef Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Thu, 28 Mar 2013 20:11:07 +0200 Subject: enable Sphinx cross-referencing for pyramid_toolbar --- docs/conf.py | 3 +++ 1 file changed, 3 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 69d00cdaa..6662b1b43 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -65,6 +65,9 @@ intersphinx_mapping = { None), 'venusian': ('http://docs.pylonsproject.org/projects/venusian/en/latest', None), + 'toolbar': + ('http://docs.pylonsproject.org/projects/pyramid_debugtoolbar/en/latest', + None), } # Add any paths that contain templates here, relative to this directory. -- cgit v1.2.3 From d4683cbbfc370fd908592399a36ea47db2570b72 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Sun, 31 Mar 2013 00:29:12 +0200 Subject: fix some cross-references Also add webtest to intersphinx_mapping --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 6662b1b43..ce1d1cce1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -55,6 +55,7 @@ extensions = [ # Looks for objects in external projects intersphinx_mapping = { + 'webtest': ('http://webtest.pythonpaste.org/en/latest', None), 'webob': ('http://docs.webob.org/en/latest', None), 'sqla': ('http://docs.sqlalchemy.org/en/latest', None), 'who': ('http://docs.repoze.org/who/latest', None), -- cgit v1.2.3 From 922e9d585d6b61e0a2261d6d45363890fe719d4f Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Wed, 3 Apr 2013 19:58:23 +0200 Subject: add zope.component to intersphinx_mapping dict --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index ce1d1cce1..1ddcae08e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -55,6 +55,7 @@ extensions = [ # Looks for objects in external projects intersphinx_mapping = { + 'zcomponent': ('http://docs.zope.org/zope.component', None), 'webtest': ('http://webtest.pythonpaste.org/en/latest', None), 'webob': ('http://docs.webob.org/en/latest', None), 'sqla': ('http://docs.sqlalchemy.org/en/latest', None), -- cgit v1.2.3 From 125ea45ae864a5513e6d83fdded6ceea9516b578 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Sat, 6 Apr 2013 07:07:37 +0200 Subject: fix some cross-references Also, pyramid_zcml is cross-referenced, so add it to intersphinx_mapping dict. --- docs/conf.py | 3 +++ 1 file changed, 3 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 1ddcae08e..67e02471f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -70,6 +70,9 @@ intersphinx_mapping = { 'toolbar': ('http://docs.pylonsproject.org/projects/pyramid_debugtoolbar/en/latest', None), + 'zcml': + ('http://docs.pylonsproject.org/projects/pyramid_zcml/en/latest', + None), } # Add any paths that contain templates here, relative to this directory. -- cgit v1.2.3 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 92deb60fdabc7092e21a0a1c48bf1b10788c7346 Mon Sep 17 00:00:00 2001 From: John Anderson Date: Fri, 3 May 2013 20:08:14 -0700 Subject: docs should be risky in master! --- 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 67e02471f..84b01a791 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -170,7 +170,7 @@ html_theme_path = ['_themes'] html_theme = 'pyramid' html_theme_options = dict( github_url='https://github.com/Pylons/pyramid', -# in_progress='true', + 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 -- cgit v1.2.3 From 0d96b77150f1283a44acd0d9c2d2f74453d298a1 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Thu, 18 Jul 2013 18:17:20 -0400 Subject: version bump in setup.py conf.py CHANGES.txt, rejigger changes bugs vs. features --- 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 84b01a791..ff5f325d8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,7 @@ copyright = '2008-%s, Agendaless Consulting' % thisyear # other places throughout the built documents. # # The short X.Y version. -version = '1.4' +version = '1.5dev' # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 83fefbf3f92183d1d899c8449a03546dd3c022a3 Mon Sep 17 00:00:00 2001 From: Paul Everitt Date: Sat, 3 Aug 2013 11:23:20 -0400 Subject: "Web Application Development Framework" -> "Web Framework". Yay. --- docs/conf.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 84b01a791..9b2f2f083 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -85,7 +85,7 @@ source_suffix = '.rst' master_doc = 'index' # General substitutions. -project = 'The Pyramid Web Application Development Framework' +project = 'The Pyramid Web Framework' thisyear = datetime.datetime.now().year copyright = '2008-%s, Agendaless Consulting' % thisyear @@ -179,7 +179,7 @@ html_theme_options = dict( # 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 +html_title = 'The Pyramid Web Framework v%s' % release # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = 'Home' @@ -251,7 +251,7 @@ latex_additional_files = ['_static/latex-note.png', '_static/latex-warning.png'] # (source start file, target name, title, author, document class [howto/manual]). latex_documents = [ ('latexindex', 'pyramid.tex', - 'The Pyramid Web Application Development Framework', + 'The Pyramid Web Framework', 'Chris McDonough', 'manual'), ] @@ -491,7 +491,7 @@ def resig(app, what, name, obj, options, signature, return_annotation): # -- Options for Epub output --------------------------------------------------- # Bibliographic Dublin Core info. -epub_title = 'The Pyramid Web Application Development Framework, Version %s' \ +epub_title = 'The Pyramid Web Framework, Version %s' \ % release epub_author = 'Chris McDonough' epub_publisher = 'Agendaless Consulting' @@ -509,7 +509,7 @@ epub_scheme = 'ISBN' epub_identifier = '0615445675' # A unique identification for the text. -epub_uid = 'The Pyramid Web Application Development Framework, Version %s' \ +epub_uid = 'The Pyramid Web 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. -- cgit v1.2.3 From 95d5b72927484fa3882c5c47bf79d591a5af50a5 Mon Sep 17 00:00:00 2001 From: Michael Merickel Date: Sun, 4 Aug 2013 05:20:26 -0500 Subject: update sphinx to use the version from the package automatically --- docs/conf.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index ff5f325d8..e50c0c60a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,6 +19,8 @@ import warnings warnings.simplefilter('ignore', DeprecationWarning) +import pkg_resources + # skip raw nodes from sphinx.writers.text import TextTranslator from sphinx.writers.latex import LaTeXTranslator @@ -93,7 +95,7 @@ copyright = '2008-%s, Agendaless Consulting' % thisyear # other places throughout the built documents. # # The short X.Y version. -version = '1.5dev' +version = pkg_resources.get_distribution('pyramid').version # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.3 From 5b47ba8ce8c8bdb149b92a2b35a5e7607ca6fc00 Mon Sep 17 00:00:00 2001 From: Paul Everitt Date: Mon, 12 Aug 2013 14:20:04 -0400 Subject: About to give Intersphinx a shot. --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 9b2f2f083..fe094a943 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -55,6 +55,7 @@ extensions = [ # Looks for objects in external projects intersphinx_mapping = { + 'tutorials': ('http://docs.pylonsproject.org/projects/pyramid_tutorials/en/latest/', None), 'zcomponent': ('http://docs.zope.org/zope.component', None), 'webtest': ('http://webtest.pythonpaste.org/en/latest', None), 'webob': ('http://docs.webob.org/en/latest', None), -- cgit v1.2.3 From 49d634bd813e63c3db5e56d29376126c2646182a Mon Sep 17 00:00:00 2001 From: Paul Everitt Date: Mon, 12 Aug 2013 19:29:23 -0400 Subject: All wrapped up, pre-merge. --- docs/conf.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index fe094a943..5870ce872 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -56,9 +56,22 @@ extensions = [ # Looks for objects in external projects intersphinx_mapping = { 'tutorials': ('http://docs.pylonsproject.org/projects/pyramid_tutorials/en/latest/', None), + 'jinja2': ('http://docs.pylonsproject.org/projects/pyramid_jinja2/en/latest/', None), + 'tm': ( + 'http://docs.pylonsproject.org/projects/pyramid_tm/en/latest/', + None, + ), + 'debugtoolbar': ( + 'http://docs.pylonsproject.org/projects/pyramid_debugtoolbar/en/latest/', None), 'zcomponent': ('http://docs.zope.org/zope.component', None), 'webtest': ('http://webtest.pythonpaste.org/en/latest', None), 'webob': ('http://docs.webob.org/en/latest', None), + 'colander': ( + 'http://docs.pylonsproject.org/projects/colander/en/latest', + None), + 'deform': ( + 'http://docs.pylonsproject.org/projects/deform/en/latest', + None), 'sqla': ('http://docs.sqlalchemy.org/en/latest', None), 'who': ('http://docs.repoze.org/who/latest', None), 'python': ('http://docs.python.org', None), -- cgit v1.2.3 From c90471defdd552b4a8c2073914cfd49e7d9f2ca0 Mon Sep 17 00:00:00 2001 From: Paul Everitt Date: Mon, 12 Aug 2013 19:59:33 -0400 Subject: Forgot to add the subdir --- docs/conf.py | 2 -- 1 file changed, 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 5870ce872..e60cd7118 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -61,8 +61,6 @@ intersphinx_mapping = { 'http://docs.pylonsproject.org/projects/pyramid_tm/en/latest/', None, ), - 'debugtoolbar': ( - 'http://docs.pylonsproject.org/projects/pyramid_debugtoolbar/en/latest/', None), 'zcomponent': ('http://docs.zope.org/zope.component', None), 'webtest': ('http://webtest.pythonpaste.org/en/latest', None), 'webob': ('http://docs.webob.org/en/latest', None), -- cgit v1.2.3 From bf84d90b4dccb9fc52c8fe385e52f7a63e9a5535 Mon Sep 17 00:00:00 2001 From: Paul Everitt Date: Tue, 13 Aug 2013 07:36:48 -0400 Subject: Add Intersphinx for Beaker, clean up some broken references, change from pip to virtualenv (and give an explanation), explain virtualenv on Python 2.7. --- docs/conf.py | 3 +++ 1 file changed, 3 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index e60cd7118..1ddcf95da 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -71,6 +71,9 @@ 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 63bac441d95637a06d628bb8e8b9888eaf812c44 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Fri, 16 Aug 2013 04:47:34 -0700 Subject: One more "The Pyramid Web Application Development Framework" to "The Pyramid Web Framework" change --- 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 4c6ed76ad..3a8076cdf 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -403,7 +403,7 @@ latex_elements = { 'wrapperclass': 'book', 'date': '', 'releasename': 'Version', - 'title': r'The Pyramid Web Application \newline Development Framework', + 'title': r'The Pyramid Web Framework', # 'pointsize':'12pt', # uncomment for 12pt version } -- cgit v1.2.3 From ffdc8cbde4fa77d55f159c4c085e0b51f8029674 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 18 Aug 2013 15:02:23 -0700 Subject: no HTML smartypants! Fix https://github.com/Pylons/pyramid/issues/669 --- 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 3a8076cdf..b6ddacea9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -221,7 +221,7 @@ 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 +html_use_smartypants = False # Custom sidebar templates, maps document names to template names. #html_sidebars = {} -- cgit v1.2.3 From 4aec433291dc7b0c08d27fe6352ecf7585052e73 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Mon, 19 Aug 2013 00:45:10 +0200 Subject: explain --- 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 b6ddacea9..a7a4a441a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -221,7 +221,7 @@ 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 = False +html_use_smartypants = False # people use cutnpaste in some places # Custom sidebar templates, maps document names to template names. #html_sidebars = {} -- cgit v1.2.3 From b1b92284f496800a4dfd2cea72cb9be07ba8661c Mon Sep 17 00:00:00 2001 From: Paul Everitt Date: Fri, 13 Sep 2013 16:52:14 -0400 Subject: First cut at import of quick tutorial. --- docs/conf.py | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index a7a4a441a..799ec7820 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -90,8 +90,39 @@ intersphinx_mapping = { 'zcml': ('http://docs.pylonsproject.org/projects/pyramid_zcml/en/latest', None), + 'pyramid': ( + 'http://docs.pylonsproject.org/projects/pyramid/en/latest/', + None) } + +#intersphinx_mapping = { +# 'python': ( +# 'http://docs.python.org/2', +# None), +# 'sqla': ( +# 'http://docs.sqlalchemy.org/en/latest', +# None), +# 'pyramid': ( +# 'http://docs.pylonsproject.org/projects/pyramid/en/latest/', +# None), +# 'jinja2': ( +# 'http://docs.pylonsproject.org/projects/pyramid_jinja2/en/latest/', +# None), +# 'toolbar': ( +# 'http://docs.pylonsproject.org/projects/pyramid_debugtoolbar/en/latest', +# None), +# 'deform': ( +# 'http://docs.pylonsproject.org/projects/deform/en/latest', +# None), +# 'colander': ( +# 'http://docs.pylonsproject.org/projects/colander/en/latest', +# None), +# 'tutorials': ( +# 'http://docs.pylonsproject.org/projects/pyramid_tutorials/en/latest/', +# None), +#} + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] -- cgit v1.2.3 From 4042c772c8043ac96a22db439a736fec9ea2aafa Mon Sep 17 00:00:00 2001 From: Paul Everitt Date: Fri, 13 Sep 2013 17:09:35 -0400 Subject: All the references re-wired. --- docs/conf.py | 30 ------------------------------ 1 file changed, 30 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 799ec7820..ee852aa51 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -90,39 +90,9 @@ intersphinx_mapping = { 'zcml': ('http://docs.pylonsproject.org/projects/pyramid_zcml/en/latest', None), - 'pyramid': ( - 'http://docs.pylonsproject.org/projects/pyramid/en/latest/', - None) } -#intersphinx_mapping = { -# 'python': ( -# 'http://docs.python.org/2', -# None), -# 'sqla': ( -# 'http://docs.sqlalchemy.org/en/latest', -# None), -# 'pyramid': ( -# 'http://docs.pylonsproject.org/projects/pyramid/en/latest/', -# None), -# 'jinja2': ( -# 'http://docs.pylonsproject.org/projects/pyramid_jinja2/en/latest/', -# None), -# 'toolbar': ( -# 'http://docs.pylonsproject.org/projects/pyramid_debugtoolbar/en/latest', -# None), -# 'deform': ( -# 'http://docs.pylonsproject.org/projects/deform/en/latest', -# None), -# 'colander': ( -# 'http://docs.pylonsproject.org/projects/colander/en/latest', -# None), -# 'tutorials': ( -# 'http://docs.pylonsproject.org/projects/pyramid_tutorials/en/latest/', -# None), -#} - # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] -- 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 From b66661a72ea2f0fe4bd6aacb83c6c5487401141b Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Tue, 8 Apr 2014 17:44:36 -0400 Subject: i have no idea why we do this in here, but let's make it at least correct --- docs/conf.py | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index a447c9968..eba776628 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -138,17 +138,21 @@ if book: # Add and use Pylons theme if 'sphinx-build' in ' '.join(sys.argv): # protect against dumb importers from subprocess import call, Popen, PIPE - - p = Popen('which git', shell=True, stdout=PIPE) cwd = os.getcwd() - _themes = os.path.join(cwd, '_themes') + p = Popen('which git', shell=True, stdout=PIPE) + here = os.path.abspath(os.path.dirname(__file__)) + parent = os.path.abspath(os.path.dirname(here)) + _themes = os.path.join(here, '_themes') git = p.stdout.read().strip() - if not os.listdir(_themes): - call([git, 'submodule', '--init']) - else: - call([git, 'submodule', 'update']) - - sys.path.append(os.path.abspath('_themes')) + try: + os.chdir(parent) + if not os.listdir(_themes): + call([git, 'submodule', '--init']) + else: + call([git, 'submodule', 'update']) + sys.path.append(_themes) + finally: + os.chdir(cwd) html_theme_path = ['_themes'] html_theme = 'pyramid' -- cgit v1.2.3 From c6c8c5ce12bceaf34a3950c2ee51e2961acaef67 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sat, 3 May 2014 22:41:51 -0700 Subject: - add cookbook to intersphinx mapping --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index eba776628..d15b1270e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -58,6 +58,7 @@ extensions = [ # Looks for objects in external projects intersphinx_mapping = { 'tutorials': ('http://docs.pylonsproject.org/projects/pyramid_tutorials/en/latest/', None), + 'cookbook': ('http://docs.pylonsproject.org/projects/pyramid_cookbook/en/latest/', None), 'jinja2': ('http://docs.pylonsproject.org/projects/pyramid_jinja2/en/latest/', None), 'tm': ( 'http://docs.pylonsproject.org/projects/pyramid_tm/en/latest/', -- cgit v1.2.3 From fc4740061c65692f6d2f23585f5efeff515cff99 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sat, 3 May 2014 22:46:35 -0700 Subject: - looks like _ are now - in RTD --- docs/conf.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index d15b1270e..4bc8e2172 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -57,9 +57,9 @@ extensions = [ # Looks for objects in external projects intersphinx_mapping = { - 'tutorials': ('http://docs.pylonsproject.org/projects/pyramid_tutorials/en/latest/', None), - 'cookbook': ('http://docs.pylonsproject.org/projects/pyramid_cookbook/en/latest/', None), - 'jinja2': ('http://docs.pylonsproject.org/projects/pyramid_jinja2/en/latest/', None), + 'tutorials': ('http://docs.pylonsproject.org/projects/pyramid-tutorials/en/latest/', None), + 'cookbook': ('http://docs.pylonsproject.org/projects/pyramid-cookbook/en/latest/', None), + 'jinja2': ('http://docs.pylonsproject.org/projects/pyramid-jinja2/en/latest/', None), 'tm': ( 'http://docs.pylonsproject.org/projects/pyramid_tm/en/latest/', None, @@ -83,10 +83,10 @@ intersphinx_mapping = { 'venusian': ('http://docs.pylonsproject.org/projects/venusian/en/latest', None), 'toolbar': - ('http://docs.pylonsproject.org/projects/pyramid_debugtoolbar/en/latest', + ('http://docs.pylonsproject.org/projects/pyramid-debugtoolbar/en/latest', None), 'zcml': - ('http://docs.pylonsproject.org/projects/pyramid_zcml/en/latest', + ('http://docs.pylonsproject.org/projects/pyramid-zcml/en/latest', None), } -- cgit v1.2.3 From 023afb1fd5eedc3f8ba24d95cad1864d05eb0444 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Tue, 16 Dec 2014 19:53:58 -0500 Subject: repoze who docs moved --- 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 4bc8e2172..fa4578275 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -74,7 +74,7 @@ intersphinx_mapping = { 'http://docs.pylonsproject.org/projects/deform/en/latest', None), 'sqla': ('http://docs.sqlalchemy.org/en/latest', None), - 'who': ('http://docs.repoze.org/who/latest', None), + 'who': ('http://repozewho.readthedocs.org/en/latest', None), 'python': ('http://docs.python.org', None), 'python3': ('http://docs.python.org/3', None), 'tstring': -- cgit v1.2.3 From 2d13f43e1b9ed574bd81e5967f8ed7789f857f3b Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Tue, 14 Apr 2015 12:10:04 -0400 Subject: no longer in-progress on this branch --- 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 fa4578275..65c0e3a8b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -159,7 +159,7 @@ html_theme_path = ['_themes'] html_theme = 'pyramid' html_theme_options = dict( github_url='https://github.com/Pylons/pyramid', - in_progress='true', + in_progress='false', ) # The name for this set of Sphinx documents. If None, it defaults to -- cgit v1.2.3 From 59626acab6014dcf433050e228a53886e764950b Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Wed, 15 Apr 2015 09:55:15 -0400 Subject: master is now 1.7 --- 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 65c0e3a8b..fa4578275 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -159,7 +159,7 @@ html_theme_path = ['_themes'] html_theme = 'pyramid' html_theme_options = dict( github_url='https://github.com/Pylons/pyramid', - in_progress='false', + in_progress='true', ) # The name for this set of Sphinx documents. If None, it defaults to -- cgit v1.2.3 From 71d66b84dbd2927e79ebf2512a4bd287b7664b84 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Thu, 16 Apr 2015 16:47:23 -0400 Subject: Replace git submodule crap with new pylons-sphinx-themes package goodness. See #1614. --- docs/conf.py | 22 ++-------------------- 1 file changed, 2 insertions(+), 20 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index fa4578275..11e42c5f3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,6 +20,7 @@ import warnings warnings.simplefilter('ignore', DeprecationWarning) import pkg_resources +import pylons_sphinx_themes # skip raw nodes from sphinx.writers.text import TextTranslator @@ -136,27 +137,8 @@ if book: # Options for HTML output # ----------------------- -# Add and use Pylons theme -if 'sphinx-build' in ' '.join(sys.argv): # protect against dumb importers - from subprocess import call, Popen, PIPE - cwd = os.getcwd() - p = Popen('which git', shell=True, stdout=PIPE) - here = os.path.abspath(os.path.dirname(__file__)) - parent = os.path.abspath(os.path.dirname(here)) - _themes = os.path.join(here, '_themes') - git = p.stdout.read().strip() - try: - os.chdir(parent) - if not os.listdir(_themes): - call([git, 'submodule', '--init']) - else: - call([git, 'submodule', 'update']) - sys.path.append(_themes) - finally: - os.chdir(cwd) - -html_theme_path = ['_themes'] html_theme = 'pyramid' +html_theme_path = pylons_sphinx_themes.get_html_themes_path() html_theme_options = dict( github_url='https://github.com/Pylons/pyramid', in_progress='true', -- cgit v1.2.3 From 82862ba554ff97932b5f6745c8e6b022dcdfe18c Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Tue, 1 Sep 2015 02:42:05 -0700 Subject: - add pylonswebframework to intersphinx config, sort entries so they can be found (meh! 79 char columns) - replace final pylonshq reference with RTD reference --- docs/conf.py | 41 ++++++++++++++--------------------------- 1 file changed, 14 insertions(+), 27 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 11e42c5f3..8a9bac6ed 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -58,37 +58,24 @@ extensions = [ # Looks for objects in external projects intersphinx_mapping = { - 'tutorials': ('http://docs.pylonsproject.org/projects/pyramid-tutorials/en/latest/', None), + 'colander': ( 'http://docs.pylonsproject.org/projects/colander/en/latest', None), 'cookbook': ('http://docs.pylonsproject.org/projects/pyramid-cookbook/en/latest/', None), + 'deform': ('http://docs.pylonsproject.org/projects/deform/en/latest', None), 'jinja2': ('http://docs.pylonsproject.org/projects/pyramid-jinja2/en/latest/', None), - 'tm': ( - 'http://docs.pylonsproject.org/projects/pyramid_tm/en/latest/', - None, - ), - 'zcomponent': ('http://docs.zope.org/zope.component', None), - 'webtest': ('http://webtest.pythonpaste.org/en/latest', None), - 'webob': ('http://docs.webob.org/en/latest', None), - 'colander': ( - 'http://docs.pylonsproject.org/projects/colander/en/latest', - None), - 'deform': ( - 'http://docs.pylonsproject.org/projects/deform/en/latest', - None), - 'sqla': ('http://docs.sqlalchemy.org/en/latest', None), - 'who': ('http://repozewho.readthedocs.org/en/latest', None), + 'pylonswebframework': ('http://docs.pylonsproject.org/projects/pylons-webframework/en/latest/', None), 'python': ('http://docs.python.org', None), 'python3': ('http://docs.python.org/3', None), - 'tstring': - ('http://docs.pylonsproject.org/projects/translationstring/en/latest', - None), - 'venusian': - ('http://docs.pylonsproject.org/projects/venusian/en/latest', None), - 'toolbar': - ('http://docs.pylonsproject.org/projects/pyramid-debugtoolbar/en/latest', - None), - 'zcml': - ('http://docs.pylonsproject.org/projects/pyramid-zcml/en/latest', - None), + 'sqla': ('http://docs.sqlalchemy.org/en/latest', None), + 'tm': ('http://docs.pylonsproject.org/projects/pyramid_tm/en/latest/', None), + 'toolbar': ('http://docs.pylonsproject.org/projects/pyramid-debugtoolbar/en/latest', None), + 'tstring': ('http://docs.pylonsproject.org/projects/translationstring/en/latest', None), + 'tutorials': ('http://docs.pylonsproject.org/projects/pyramid-tutorials/en/latest/', None), + 'venusian': ('http://docs.pylonsproject.org/projects/venusian/en/latest', None), + 'webob': ('http://docs.webob.org/en/latest', None), + 'webtest': ('http://webtest.pythonpaste.org/en/latest', None), + 'who': ('http://repozewho.readthedocs.org/en/latest', None), + 'zcml': ('http://docs.pylonsproject.org/projects/pyramid-zcml/en/latest', None), + 'zcomponent': ('http://docs.zope.org/zope.component', None), } -- cgit v1.2.3 From 50dd2e4c7d8f5ab8de79c490e304b44916183f77 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 20 Dec 2015 14:00:12 -0800 Subject: add sphinxcontrib-programoutput configuration to render command line output --- docs/conf.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 8a9bac6ed..073811eca 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -53,12 +53,13 @@ extensions = [ 'sphinx.ext.doctest', 'repoze.sphinx.autointerface', 'sphinx.ext.viewcode', - 'sphinx.ext.intersphinx' + 'sphinx.ext.intersphinx', + 'sphinxcontrib.programoutput', ] # Looks for objects in external projects intersphinx_mapping = { - 'colander': ( 'http://docs.pylonsproject.org/projects/colander/en/latest', None), + 'colander': ('http://docs.pylonsproject.org/projects/colander/en/latest', None), 'cookbook': ('http://docs.pylonsproject.org/projects/pyramid-cookbook/en/latest/', None), 'deform': ('http://docs.pylonsproject.org/projects/deform/en/latest', None), 'jinja2': ('http://docs.pylonsproject.org/projects/pyramid-jinja2/en/latest/', None), @@ -66,8 +67,8 @@ intersphinx_mapping = { 'python': ('http://docs.python.org', None), 'python3': ('http://docs.python.org/3', None), 'sqla': ('http://docs.sqlalchemy.org/en/latest', None), - 'tm': ('http://docs.pylonsproject.org/projects/pyramid_tm/en/latest/', None), - 'toolbar': ('http://docs.pylonsproject.org/projects/pyramid-debugtoolbar/en/latest', None), + 'tm': ('http://docs.pylonsproject.org/projects/pyramid_tm/en/latest/', None), + 'toolbar': ('http://docs.pylonsproject.org/projects/pyramid-debugtoolbar/en/latest', None), 'tstring': ('http://docs.pylonsproject.org/projects/translationstring/en/latest', None), 'tutorials': ('http://docs.pylonsproject.org/projects/pyramid-tutorials/en/latest/', None), 'venusian': ('http://docs.pylonsproject.org/projects/venusian/en/latest', None), -- cgit v1.2.3 From bd88dcd361a7a25450ee4abb7416b83cddd93ee2 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Fri, 29 Jan 2016 22:43:22 -0800 Subject: update instructions for major release in conf.py html_theme_options --- docs/conf.py | 3 +++ 1 file changed, 3 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 073811eca..4cac1e913 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -129,7 +129,10 @@ html_theme = 'pyramid' html_theme_path = pylons_sphinx_themes.get_html_themes_path() html_theme_options = dict( github_url='https://github.com/Pylons/pyramid', + # on master branch true, else false in_progress='true', + # on previous branches/major releases true, else false + outdated='false', ) # The name for this set of Sphinx documents. If None, it defaults to -- cgit v1.2.3 From 48738dc116f9916356ac1d41029c3682b978a4ed Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sat, 30 Jan 2016 18:04:49 -0800 Subject: add instructions for enabling pylons_sphinx_latesturl on previously released branch when making a new major release --- docs/conf.py | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 4cac1e913..1004e1cf9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -55,6 +55,8 @@ extensions = [ 'sphinx.ext.viewcode', 'sphinx.ext.intersphinx', 'sphinxcontrib.programoutput', + # enable pylons_sphinx_latesturl when this branch is no longer "latest" + # 'pylons_sphinx_latesturl', ] # Looks for objects in external projects @@ -124,6 +126,21 @@ if book: # Options for HTML output # ----------------------- +# enable pylons_sphinx_latesturl when this branch is no longer "latest" +# pylons_sphinx_latesturl_base = ( +# 'http://docs.pylonsproject.org/projects/pyramid/en/latest/') +# pylons_sphinx_latesturl_pagename_overrides = { +# # map old pagename -> new pagename +# 'whatsnew-1.0': 'index', +# 'whatsnew-1.1': 'index', +# 'whatsnew-1.2': 'index', +# 'whatsnew-1.3': 'index', +# 'whatsnew-1.4': 'index', +# 'whatsnew-1.5': 'index', +# 'tutorials/gae/index': 'index', +# 'api/chameleon_text': 'api', +# 'api/chameleon_zpt': 'api', +# } html_theme = 'pyramid' html_theme_path = pylons_sphinx_themes.get_html_themes_path() -- cgit v1.2.3 From ed04017d5a8e82db2e46412f841c55d83ef062b0 Mon Sep 17 00:00:00 2001 From: Michael Merickel Date: Sun, 7 Feb 2016 14:00:20 -0600 Subject: fix pyramid_tm 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 1004e1cf9..a895bc6c3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -69,7 +69,7 @@ intersphinx_mapping = { 'python': ('http://docs.python.org', None), 'python3': ('http://docs.python.org/3', None), 'sqla': ('http://docs.sqlalchemy.org/en/latest', None), - 'tm': ('http://docs.pylonsproject.org/projects/pyramid_tm/en/latest/', None), + 'tm': ('http://docs.pylonsproject.org/projects/pyramid-tm/en/latest/', None), 'toolbar': ('http://docs.pylonsproject.org/projects/pyramid-debugtoolbar/en/latest', None), 'tstring': ('http://docs.pylonsproject.org/projects/translationstring/en/latest', None), 'tutorials': ('http://docs.pylonsproject.org/projects/pyramid-tutorials/en/latest/', None), -- cgit v1.2.3 From 186b72e56600c79888795fa4eed286a5ebf71974 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Wed, 6 Apr 2016 04:24:28 -0700 Subject: - remove conf.py straggler - update intersphinx link to python3 docs - Closes #2429 --- docs/conf.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index a895bc6c3..1600e1f5c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -66,8 +66,7 @@ intersphinx_mapping = { 'deform': ('http://docs.pylonsproject.org/projects/deform/en/latest', None), 'jinja2': ('http://docs.pylonsproject.org/projects/pyramid-jinja2/en/latest/', None), 'pylonswebframework': ('http://docs.pylonsproject.org/projects/pylons-webframework/en/latest/', None), - 'python': ('http://docs.python.org', None), - 'python3': ('http://docs.python.org/3', None), + 'python': ('https://docs.python.org/3', None), 'sqla': ('http://docs.sqlalchemy.org/en/latest', None), 'tm': ('http://docs.pylonsproject.org/projects/pyramid-tm/en/latest/', None), 'toolbar': ('http://docs.pylonsproject.org/projects/pyramid-debugtoolbar/en/latest', None), -- cgit v1.2.3 From 86e187a734728611bc8bfd5792133502ffd59160 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sat, 16 Apr 2016 04:44:55 -0700 Subject: quick_tutorial cleanup - replace nose with pytest - cleanup unit_testing.rst --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 1600e1f5c..c40f1c875 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -67,6 +67,7 @@ intersphinx_mapping = { 'jinja2': ('http://docs.pylonsproject.org/projects/pyramid-jinja2/en/latest/', None), 'pylonswebframework': ('http://docs.pylonsproject.org/projects/pylons-webframework/en/latest/', None), 'python': ('https://docs.python.org/3', None), + 'pytest': ('http://pytest.org/latest/', None), 'sqla': ('http://docs.sqlalchemy.org/en/latest', None), 'tm': ('http://docs.pylonsproject.org/projects/pyramid-tm/en/latest/', None), 'toolbar': ('http://docs.pylonsproject.org/projects/pyramid-debugtoolbar/en/latest', None), -- cgit v1.2.3 From 7c9eab4730efac736064ec35a312d3a7936674d2 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 17 Apr 2016 01:31:55 -0700 Subject: update RELEASING.txt with version terms, extra step update conf.py with clearer comments and prep for rolldown for 1.6 --- docs/conf.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index c40f1c875..786ff3abf 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -137,6 +137,7 @@ if book: # 'whatsnew-1.3': 'index', # 'whatsnew-1.4': 'index', # 'whatsnew-1.5': 'index', +# 'whatsnew-1.6': 'index', # 'tutorials/gae/index': 'index', # 'api/chameleon_text': 'api', # 'api/chameleon_zpt': 'api', @@ -146,9 +147,10 @@ html_theme = 'pyramid' html_theme_path = pylons_sphinx_themes.get_html_themes_path() html_theme_options = dict( github_url='https://github.com/Pylons/pyramid', - # on master branch true, else false + # On master branch and new branch still in + # pre-release status: true; else: false. in_progress='true', - # on previous branches/major releases true, else false + # On branches previous to "latest": true; else: false. outdated='false', ) -- cgit v1.2.3 From a575d1f9d77195d53f55fa8b409bd7c21f3f64de Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 17 Apr 2016 15:38:26 -0700 Subject: update RELEASING.txt to better account for master and previous branches - add term "final" release - explicitify the implicit - --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 786ff3abf..518f7e784 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -138,6 +138,7 @@ if book: # 'whatsnew-1.4': 'index', # 'whatsnew-1.5': 'index', # 'whatsnew-1.6': 'index', +# 'whatsnew-1.7': 'index', # 'tutorials/gae/index': 'index', # 'api/chameleon_text': 'api', # 'api/chameleon_zpt': 'api', -- cgit v1.2.3