diff options
| author | Goodwill Coding <goodwillcoding@webhippo.net> | 2013-01-05 10:23:35 -0800 |
|---|---|---|
| committer | Goodwill Coding <goodwillcoding@webhippo.net> | 2013-01-05 10:23:35 -0800 |
| commit | 09f43d3ba25ba2189a1b9abf6978e14690034d16 (patch) | |
| tree | 89556a2bdf4ca12fb72fa60643df11aa22d5a097 | |
| parent | 2b164460337dd655f9aebb25a10e6f0f35363656 (diff) | |
| download | pyramid-09f43d3ba25ba2189a1b9abf6978e14690034d16.tar.gz pyramid-09f43d3ba25ba2189a1b9abf6978e14690034d16.tar.bz2 pyramid-09f43d3ba25ba2189a1b9abf6978e14690034d16.zip | |
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
| -rw-r--r-- | docs/conf.py | 31 | ||||
| -rwxr-xr-x | docs/remake | 2 |
2 files changed, 19 insertions, 14 deletions
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. diff --git a/docs/remake b/docs/remake index eb818289f..6552716c8 100755 --- a/docs/remake +++ b/docs/remake @@ -1 +1 @@ -make clean html SPHINXBUILD=../env27/bin/sphinx-build +make clean html SPHINXBUILD=../env/bin/sphinx-build |
