]> git.ipfire.org Git - thirdparty/krb5.git/commitdiff
Replace UTF-8 with ASCII
authorBen Kaduk <kaduk@mit.edu>
Tue, 6 Nov 2012 00:22:07 +0000 (19:22 -0500)
committerBen Kaduk <kaduk@mit.edu>
Wed, 14 Nov 2012 20:33:20 +0000 (15:33 -0500)
We try to restrict non-ASCII to names.

Python does not accept U+2013 EN DASH as indicating a command-line
argument; U+2D HYPHEN-MINUS is required.

Replace U+201C LEFT DOUBLE QUOTATION MARK and U+201D RIGHT
DOUBLE QUOTATION MARK with ordinary ASCII quotes.

ticket: 7433
tags: pullup

doc/tools/README

index ccbed6cf9ac107c35fe0cb7514292936e3fa1c02..c86fe8b5124cfd6bf185a09dac5f83ae3a795b2e 100644 (file)
@@ -6,7 +6,7 @@ The text below is meant to give the instructions on how to incorporate MIT Kerbe
 Pre-requisites:
 - python 2.5+ with Cheetah, lxml and  xml extension modules installed;
 - For part B only:
-    -    Sphinx “doxylink” extension;
+    -    Sphinx "doxylink" extension;
     -    Doxygen HTML output
 
 
@@ -18,17 +18,17 @@ Part A:    Transforming Doxygen XML output into reStructuredText (rst)  without
 
 3.    Suppose the Doxygen XML output is located in doxy_xml_dir  and the desired output directory is rst_dir.
       Run:
-      python doxy.py –i  doxy_xml_dir –o rst_dir –t func
+      python doxy.py -i  doxy_xml_dir -o rst_dir -t func
       This will result in the storing of the API function documentation files in rst format in the rst_dir. The file names are constructed based on the function name. For example, the file for krb5_build_principal() will be krb5_build_principal.rst
 
       Run:
-      python doxy.py –i  doxy_xml_dir –o rst_dir –t typedef
+      python doxy.py -i  doxy_xml_dir -o rst_dir -t typedef
       It is similar to the API function conversion, but for data types. The result will be stored under rst_dir/types directory
 
       Alternatively, running
-      python doxy.py –i  doxy_xml_dir –o rst_dir
+      python doxy.py -i  doxy_xml_dir -o rst_dir
       or
-      python doxy.py –i  doxy_xml_dir –o rst_dir -t all
+      python doxy.py -i  doxy_xml_dir -o rst_dir -t all
       converts Doxygen XML output into reStructuredText format files both for API functions and data types;
 
 4.    In appdev/index.rst add the following section to point to the API references:
@@ -53,7 +53,7 @@ Part B:    Bridge to Doxygen HTML output.
        GENERATE_TAGFILE       = krb5doxy.tag
        GENERATE_XML           = YES
 
-2. Modify Sphinx conf.py file to point to the “doxylink” extension and Doxygen tag file:
+2. Modify Sphinx conf.py file to point to the "doxylink" extension and Doxygen tag file:
       extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.doxylink']
       doxylink = { ' krb5doxy' : ('/tmp/krb5doxy.tag, ' doxy_html_dir ') }