/usr/lib/python2.7/dist-packages/dolfin_utils/documentation/generatecpprst.py is in python-dolfin 1.3.0+dfsg-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 | # Copyright (C) 2010 Anders Logg and Kristian Oelgaard
#
# This file is part of DOLFIN.
#
# DOLFIN is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# DOLFIN is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with DOLFIN. If not, see <http://www.gnu.org/licenses/>.
#
# Modified by Marie E. Rognes
#
# First added: 2010
# Last changed: 2011-05-23
import os
# Import the documentation extractor tools from dolfin_utils
from dolfin_utils.documentation import extract_doc_representation
from dolfin_utils.documentation import indent, add_links
import indextemplates as templates
__all__ = ["generate_cpp_api_documentation"]
def write_class_doc(classname, parents, comment, function_documentation,
classnames):
output = []
base_indent = 0
if classname is not None:
base_indent = 4
output += [".. cpp:class:: %s\n" % classname]
if parents is not None:
output += [indent("*Parent class(es)*\n", 4)]
for parent in parents:
output += [indent("* :cpp:class:`%s`\n" % parent, 8)]
if comment is not None:
comment = add_links(comment, classnames, ":cpp:class:") #NB
output += [indent(comment, 4)] + ["\n"]
else:
output += ["\n"]
for (signature, comment) in function_documentation:
# Handle indentation of signature # Hm?
if "\n" in signature:
lines = signature.split("\n")
signature = ("\n".join([lines[0]]
+ [(len(".. cpp.function::") + 1)*" " + l
for l in lines[1:]]))
# Add crosslinks in comment
comment = add_links(comment, classnames, ":cpp:class:")
output += [indent(".. cpp:function:: %s\n" % signature, base_indent)]
output += [indent(comment, base_indent + 4), "\n"]
text = "\n".join(output)
return text
def generate_header_rst_file(module, header, documentation, classnames):
output = []
for (classname, parents, comment, function_documentation) in documentation:
output += [write_class_doc(classname, parents, comment,
function_documentation, classnames)]
text = "\n".join(output)
note = indent(templates.note_template, 4)
dictionary = {"module": module, "header": header,
"prefix": header.split(".")[0].lower(),
"title": header, "formatting": len(header)*"=",
"note": note, "text": text}
template = templates.header_cpp_template % dictionary
return template
def open_write_close(filename, contents):
f = open(filename, "w")
f.write(contents)
f.close()
def generate_cpp_module(module, documentation, classnames, output_dir):
print indent("Generating documentation for %s ... " % module, 0)
# Generate index file for this module
module_index = templates.generate_module_index(module)
index_filename = os.path.join(output_dir, "index.rst")
open_write_close(index_filename, module_index)
# Generate .rst for each header file in this module
for (header, doc) in documentation:
#print indent("Generating documentation for %s" % header, 2)
rst_filename = os.path.join(output_dir, header.split(".")[0] + ".rst")
header_rst = generate_header_rst_file(module, header, doc,
classnames)
open_write_close(rst_filename, header_rst)
return
def generate_cpp_api_documentation(input_dir, output_dir, version=None):
"""
Generate .rst files for C++ DOLFIN Programmer's Reference
Arguments:
* version
version should be the version number, example 0.9.11 or dev
"""
print "Generating .rst for C++ API documentation of DOLFIN-%s" % version
print "This can take some time ..."
print "Reading from %s" % input_dir
try:
os.makedirs(output_dir)
print "Creating output directory: %s" % output_dir
except:
print "Output directory (%s) already existing" % output_dir
# Get representation
documentation, classnames = extract_doc_representation(input_dir)
# Generate index file for library
library_index = templates.generate_library_index(version)
library_index_filename = os.path.join(output_dir, "index.rst")
open_write_close(library_index_filename, library_index)
# Generate documentation for each module
for module in documentation:
# Create directory for this module
module_dir = os.path.join(output_dir, module)
try:
os.makedirs(module_dir)
except:
pass
# Create documentation for this module
generate_cpp_module(module, documentation[module], classnames,
module_dir)
|