Skip to content

Commit

Permalink
Replace UTF-8 with ASCII
Browse files Browse the repository at this point in the history
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.

(cherry picked from commit b1ba4ac)

ticket: 7433
version_fixed: 1.11
status: resolved
  • Loading branch information
kaduk authored and tlyu committed Nov 16, 2012
1 parent b88e89b commit cb85a51
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions doc/tools/README
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand All @@ -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:
Expand All @@ -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 ') }

Expand Down

0 comments on commit cb85a51

Please sign in to comment.