/usr/share/doc/gnat-gps/html/Printing-the-GPS-Python-documentation.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 2002-2010 AdaCore.

This document is free; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This document 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 General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, see http://www.gnu.org/licenses/.

A copy of the license is included in the section entitled
"GNU General Public License". -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Using the GNAT Programming Studio: Printing the GPS Python documentation</title>

<meta name="description" content="Using the GNAT Programming Studio: Printing the GPS Python documentation">
<meta name="keywords" content="Using the GNAT Programming Studio: Printing the GPS Python documentation">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Index-table.html#Index-table" rel="index" title="Index table">
<link href="Python-FAQ.html#Python-FAQ" rel="up" title="Python FAQ">
<link href="Automatically-loading-python-files-at-startup.html#Automatically-loading-python-files-at-startup" rel="next" title="Automatically loading python files at startup">
<link href="Reloading-a-python-file-in-GPS.html#Reloading-a-python-file-in-GPS" rel="previous" title="Reloading a python file in GPS">
<style type="text/css">
<!--
   

a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
pre.smallexample {background-color:rgb(240,240,240);
                     font-family: courier new,courier,fixed;
                     font-size: 14px;
                     margin: 0px 40px 0px 40px;
                     border-width: 1px 2px 2px 1px;
                     border-top-style: dotted;
                     border-left-style: dotted;
                     border-right-style: solid;
                     border-bottom-style: solid;
                     border-color: black;}
   code             {color:black;
                     font-family: courier new,courier,fixed;
                     font-size: 14px;}
   body             {font-family: arial,helvetica,sans-serif;
                     font-size: 16px;
                     max-width: 800px;
                     text-align: justify}
   samp             {font-family: courier new,courier,fixed;
                     font-size: 14px}
                    

-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Printing-the-GPS-Python-documentation"></a>
<div class="header">
<p>
Next: <a href="Automatically-loading-python-files-at-startup.html#Automatically-loading-python-files-at-startup" accesskey="n" rel="next">Automatically loading python files at startup</a>, Previous: <a href="Reloading-a-python-file-in-GPS.html#Reloading-a-python-file-in-GPS" accesskey="p" rel="previous">Reloading a python file in GPS</a>, Up: <a href="Python-FAQ.html#Python-FAQ" accesskey="u" rel="up">Python FAQ</a> &nbsp; [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Printing-the-GPS-Python-documentation-1"></a>
<h4 class="subsubsection">16.8.7.7 Printing the GPS Python documentation</h4>

<p>The python extension provided by GPS is fully documentation in this
manual and a separate manual accessible through the Help menu in GPS.
</p>
<p>However, this documentation is provided in HTML, and might not be the
best suitable for printing, if you wish to do so.
</p>
<p>The following paragraph explains how you can generate your own documentation
for any python module, including GPS, and print the result.
</p>
<div class="smallexample">
<pre class="smallexample">import pydoc
pydoc.writedoc (GPS)
</pre></div>

<p>In the last comamnd, <code>GPS</code> is the name of the module that you want
to print the documentation for.
</p>
<p>These commands generate a <samp>.html</samp> file in the current directory.
</p>
<p>Alternatively, you can generate a simple text file with
</p>
<div class="smallexample">
<pre class="smallexample">e=file(&quot;./python_doc&quot;, &quot;w&quot;)
e.write (pydoc.text.document (GPS))
e.flush()
</pre></div>

<p>This text file includes bold characters by default. Such bold characters
are correctly interpreted by tools such as <samp>a2ps</samp> which can be used
to convert the text file into a postscript document.
</p>



</body>
</html>
gnat-gps-doc 5.0-16 / usr / share / doc / gnat-gps / html / Printing-the-GPS-Python-documentation.html
