Ticket #7384: trac_7384-sphinxify-docstrings.patch

sagenb/misc/sphinxify.py

@@ -1 @@
-#!/usr/bin/python
+#!/usr/bin/env python
 r"""
 Process docstrings with Sphinx
 
 Processes docstrings with Sphinx. Can also be used as a commandline script:
 
-$ python sphinxify.py <text>
+``python sphinxify.py <text>``
 
 AUTHORS:
 
 - Tim Joseph Dumol (2009-09-29): initial version
-
+"""
 #**************************************************
 # Copyright (C) 2009 Tim Dumol <tim@timdumol.com>
 #
 # Distributed under the terms of the BSD License
 #**************************************************
-"""
 import os, hashlib, re, shutil
 from tempfile import mkdtemp
 
@@ -35 +34 @@
     return ("`" in docstring or "::" in docstring)
 
 def sphinxify(docstring):
-    """
+    r"""
     Runs Sphinx on a docstring, and outputs the processed documentation.
 
     INPUT:
@@ -49 +48 @@
     EXAMPLES::
 
         sage: from sagenb.misc.sphinxify import sphinxify
-        sage: sphinxify('Foobar')
-        '\n<div class="docstring">\n    \n  \n  <p>Foobar</p>\n\n\n</div>'
+        sage: sphinxify('A test')
+        '\n<div class="docstring">\n    \n  <p>A test</p>\n\n\n</div>'
         sage: sphinxify('**Testing**\n`monospace`')
-        '\n<div class="docstring"...<strong>Testing</strong>\n<img..." alt="monospace" /></p>\n\n\n</div>'
+        '\n<div class="docstring"...<strong>Testing</strong>\n<span class="math"...</p>\n\n\n</div>'
     """
     tmpdir = mkdtemp()
     docstring_hash = hashlib.md5(docstring).hexdigest()
@@ -108 +107 @@
     return new_html
 
 def generate_configuration(directory):
-    """
+    r"""
     Generates Sphinx configuration at ``directory``.
 
     EXAMPLES::
@@ -118 +117 @@
         sage: tmpdir = tempfile.mkdtemp()
         sage: generate_configuration(tmpdir)
         sage: open(os.path.join(tmpdir, 'conf.py')).read()
-        '\nextensions =...templates_path...NestedClass\n    '
+        '\n...extensions =...templates_path...source = False\n...'
     """
     conf = r'''
 ###########################################################