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