[OpenSPARC-T2-SAM] / sam-t2 / devtools / v8plus / html / python / doc / intro.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="doc.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="doc.html" title='Documenting Python' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="directories.html" />
<link rel="prev" href="contents.html" />
<link rel="parent" href="doc.html" />
<link rel="next" href="directories.html" />
<meta name='aesop' content='information' />
<title>1 Introduction </title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="Contents"
  href="contents.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="Documenting Python"
  href="doc.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="2 Directory Structure"
  href="directories.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Documenting Python</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="contents.html">Contents</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="doc.html">Documenting Python</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="directories.html">2 Directory Structure</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H1><A NAME="SECTION000200000000000000000"></A><A NAME="intro"></A>
<BR>
1 Introduction 
</H1>

<P>
Python's documentation has long been considered to be good for a
  free programming language.  There are a number of reasons for this,
  the most important being the early commitment of Python's creator,
  Guido van Rossum, to providing documentation on the language and its
  libraries, and the continuing involvement of the user community in
  providing assistance for creating and maintaining documentation.

<P>
The involvement of the community takes many forms, from authoring to
  bug reports to just plain complaining when the documentation could
  be more complete or easier to use.  All of these forms of input from
  the community have proved useful during the time I've been involved
  in maintaining the documentation.

<P>
This document is aimed at authors and potential authors of
  documentation for Python.  More specifically, it is for people
  contributing to the standard documentation and developing additional
  documents using the same tools as the standard documents.  This
  guide will be less useful for authors using the Python documentation
  tools for topics other than Python, and less useful still for
  authors not using the tools at all.

<P>
The material in this guide is intended to assist authors using the
  Python documentation tools.  It includes information on the source
  distribution of the standard documentation, a discussion of the
  document types, reference material on the markup defined in the
  document classes, a list of the external tools needed for processing
  documents, and reference material on the tools provided with the
  documentation resources.  At the end, there is also a section
  discussing future directions for the Python documentation and where
  to turn for more information.

<P>
If your interest is in contributing to the Python documentation, but
  you don't have the time or inclination to learn <span class="LaTeX">LaTeX</span> and the
  markup structures documented here, there's a welcoming place for you
  among the Python contributors as well.  Any time you feel that you
  can clarify existing documentation or provide documentation that's
  missing, the existing documentation team will gladly work with you
  to integrate your text, dealing with the markup for you.  Please
  don't let the material in this document stand between the
  documentation and your desire to help out!

<P>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="Contents"
  href="contents.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="Documenting Python"
  href="doc.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="2 Directory Structure"
  href="directories.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Documenting Python</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="contents.html">Contents</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="doc.html">Documenting Python</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="directories.html">2 Directory Structure</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>
Commit	Line	Data
920dae64 AT	1	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	2	<html>
	3	<head>
	4	<link rel="STYLESHEET" href="doc.css" type='text/css' />
	5	<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
	6	<link rel='start' href='../index.html' title='Python Documentation Index' />
	7	<link rel="first" href="doc.html" title='Documenting Python' />
	8	<link rel='contents' href='contents.html' title="Contents" />
	9	<link rel='last' href='about.html' title='About this document...' />
	10	<link rel='help' href='about.html' title='About this document...' />
	11	<link rel="next" href="directories.html" />
	12	<link rel="prev" href="contents.html" />
	13	<link rel="parent" href="doc.html" />
	14	<link rel="next" href="directories.html" />
	15	<meta name='aesop' content='information' />
	16	<title>1 Introduction </title>
	17	</head>
	18	<body>
	19	<DIV CLASS="navigation">
	20	<div id='top-navigation-panel' xml:id='top-navigation-panel'>
	21	<table align="center" width="100%" cellpadding="0" cellspacing="2">
	22	<tr>
	23	<td class='online-navigation'><a rel="prev" title="Contents"
	24	href="contents.html"><img src='../icons/previous.png'
	25	border='0' height='32' alt='Previous Page' width='32' /></A></td>
	26	<td class='online-navigation'><a rel="parent" title="Documenting Python"
	27	href="doc.html"><img src='../icons/up.png'
	28	border='0' height='32' alt='Up One Level' width='32' /></A></td>
	29	<td class='online-navigation'><a rel="next" title="2 Directory Structure"
	30	href="directories.html"><img src='../icons/next.png'
	31	border='0' height='32' alt='Next Page' width='32' /></A></td>
	32	<td align="center" width="100%">Documenting Python</td>
	33	<td class='online-navigation'><a rel="contents" title="Table of Contents"
	34	href="contents.html"><img src='../icons/contents.png'
	35	border='0' height='32' alt='Contents' width='32' /></A></td>
	36	<td class='online-navigation'><img src='../icons/blank.png'
	37	border='0' height='32' alt='' width='32' /></td>
	38	<td class='online-navigation'><img src='../icons/blank.png'
	39	border='0' height='32' alt='' width='32' /></td>
	40	</tr></table>
	41	<div class='online-navigation'>
	42	<b class="navlabel">Previous:</b>
	43	<a class="sectref" rel="prev" href="contents.html">Contents</A>
	44	<b class="navlabel">Up:</b>
	45	<a class="sectref" rel="parent" href="doc.html">Documenting Python</A>
	46	<b class="navlabel">Next:</b>
	47	<a class="sectref" rel="next" href="directories.html">2 Directory Structure</A>
	48	</div>
	49	<hr /></div>
	50	</DIV>
	51	<!--End of Navigation Panel-->
	52
	53	<H1><A NAME="SECTION000200000000000000000"></A><A NAME="intro"></A>
	54	<BR>
	55	1 Introduction
	56	</H1>
	57
	58	<P>
	59	Python's documentation has long been considered to be good for a
	60	free programming language. There are a number of reasons for this,
	61	the most important being the early commitment of Python's creator,
	62	Guido van Rossum, to providing documentation on the language and its
	63	libraries, and the continuing involvement of the user community in
	64	providing assistance for creating and maintaining documentation.
65
66	<P>
67	The involvement of the community takes many forms, from authoring to
68	bug reports to just plain complaining when the documentation could
69	be more complete or easier to use. All of these forms of input from
70	the community have proved useful during the time I've been involved
71	in maintaining the documentation.
72
73	<P>
74	This document is aimed at authors and potential authors of
75	documentation for Python. More specifically, it is for people
76	contributing to the standard documentation and developing additional
77	documents using the same tools as the standard documents. This
78	guide will be less useful for authors using the Python documentation
79	tools for topics other than Python, and less useful still for
80	authors not using the tools at all.
81
82	<P>
83	The material in this guide is intended to assist authors using the
84	Python documentation tools. It includes information on the source
85	distribution of the standard documentation, a discussion of the
86	document types, reference material on the markup defined in the
87	document classes, a list of the external tools needed for processing
88	documents, and reference material on the tools provided with the
89	documentation resources. At the end, there is also a section
90	discussing future directions for the Python documentation and where
91	to turn for more information.
92
93	<P>
94	If your interest is in contributing to the Python documentation, but
95	you don't have the time or inclination to learn <span class="LaTeX">LaTeX</span> and the
96	markup structures documented here, there's a welcoming place for you
97	among the Python contributors as well. Any time you feel that you
98	can clarify existing documentation or provide documentation that's
99	missing, the existing documentation team will gladly work with you
100	to integrate your text, dealing with the markup for you. Please
101	don't let the material in this document stand between the
102	documentation and your desire to help out!
103
104	<P>
105
106	<DIV CLASS="navigation">
107	<div class='online-navigation'>
108	<p></p><hr />
109	<table align="center" width="100%" cellpadding="0" cellspacing="2">
110	<tr>
111	<td class='online-navigation'><a rel="prev" title="Contents"
112	href="contents.html"><img src='../icons/previous.png'
113	border='0' height='32' alt='Previous Page' width='32' /></A></td>
114	<td class='online-navigation'><a rel="parent" title="Documenting Python"
115	href="doc.html"><img src='../icons/up.png'
116	border='0' height='32' alt='Up One Level' width='32' /></A></td>
117	<td class='online-navigation'><a rel="next" title="2 Directory Structure"
118	href="directories.html"><img src='../icons/next.png'
119	border='0' height='32' alt='Next Page' width='32' /></A></td>
120	<td align="center" width="100%">Documenting Python</td>
121	<td class='online-navigation'><a rel="contents" title="Table of Contents"
122	href="contents.html"><img src='../icons/contents.png'
123	border='0' height='32' alt='Contents' width='32' /></A></td>
124	<td class='online-navigation'><img src='../icons/blank.png'
125	border='0' height='32' alt='' width='32' /></td>
126	<td class='online-navigation'><img src='../icons/blank.png'
127	border='0' height='32' alt='' width='32' /></td>
128	</tr></table>
129	<div class='online-navigation'>
130	<b class="navlabel">Previous:</b>
131	<a class="sectref" rel="prev" href="contents.html">Contents</A>
132	<b class="navlabel">Up:</b>
133	<a class="sectref" rel="parent" href="doc.html">Documenting Python</A>
134	<b class="navlabel">Next:</b>
135	<a class="sectref" rel="next" href="directories.html">2 Directory Structure</A>
136	</div>
137	</div>
138	<hr />
139	<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
140	</DIV>
141	<!--End of Navigation Panel-->
142	<ADDRESS>
143	See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
144	</ADDRESS>
145	</BODY>
146	</HTML>