Skip to content

Commit

Permalink
Merge doc-index-5429
Browse files Browse the repository at this point in the history 
Author: mesozoic
Reviewer: jesstess
Fixes: twisted#5429

Add an index page to the documentation tree and make references to "Twisted Products" within the documentation more consistent.



git-svn-id: svn://svn.twistedmatrix.com/svn/Twisted/trunk@33398 bbbe8e31-12d6-0310-92fd-ac37d47ddeeb
mesozoic committed Dec 21, 2011
1 parent 83335d2 commit 2266ced
Showing 19 changed files with 337 additions and 34 deletions.
4 changes: 2 additions & 2 deletions doc/conch/examples/index.xhtml
View file
Original file line number Diff line number Diff line change
@@ -4,11 +4,11 @@

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Twisted.Conch code examples</title>
<title>Twisted Conch code examples</title>
</head>

<body>
<h1>Twisted.Conch code examples</h1>
<h1>Twisted Conch code examples</h1>

<h2>Simple SSH server and client</h2>
<ul>
6 changes: 3 additions & 3 deletions doc/conch/howto/conch_client.xhtml
View file
Original file line number Diff line number Diff line change
@@ -4,18 +4,18 @@

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Writing a client with Twisted.Conch</title>
<title>Writing a client with Twisted Conch</title>
</head>

<body>
<h1>Writing a client with Twisted.Conch</h1>
<h1>Writing a client with Twisted Conch</h1>

<h2>Introduction</h2>

<p>In the original days of computing, rsh/rlogin were used to connect to
remote computers and execute commands. These commands had the problem
that the passwords and commands were sent in the clear. To solve this
problem, the SSH protocol was created. Twisted.Conch implements the
problem, the SSH protocol was created. Twisted Conch implements the
second version of this protocol.</p>

<h2>Writing a client</h2>
2 changes: 0 additions & 2 deletions doc/core/index.xhtml
View file
Original file line number Diff line number Diff line change
@@ -4,8 +4,6 @@
<ul>
<li><a href="howto/index.xhtml">Developer guides</a>: documentation on using
Twisted Core to develop your own applications</li>
<li><a href="upgrades/index.xhtml">Upgrades between versions</a>:
documentation specific to upgrading between versions of Twisted core</li>
<li><a href="examples/index.xhtml">Examples</a>: short code examples using
Twisted Core</li>
<li><a href="specifications/index.xhtml">Specifications</a>: specification
2 changes: 1 addition & 1 deletion doc/historic/2002/ipc10/twisted-network-framework/index.html
View file
Original file line number Diff line number Diff line change
@@ -1555,7 +1555,7 @@ <h3>References</h3>
<li>Using Spreadable Web Servers,
http://www.twistedmatrix.com/users/jh.twistd/python/moin.cgi/TwistedWeb</li>

<li>Twisted.Spread implementations for other languages,
<li>Twisted Spread implementations for other languages,
http://www.twistedmatrix.com/users/washort/</li>

<li>PHP: Hypertext Preprocessor, http://www.php.net/</li>
2 changes: 1 addition & 1 deletion doc/historic/2003/pycon/applications/applications.html
View file
Original file line number Diff line number Diff line change
@@ -104,7 +104,7 @@ <h3>Implementation</h3>

<h3>Shortcomings</h3>

<p>There are several aspects of Twisted.Names that might preclude its
<p>There are several aspects of Twisted Names that might preclude its
use in "production" software. These issues stem mainly from its
immaturity, it being less than six months old at the writing of this
paper.</p>
2 changes: 1 addition & 1 deletion doc/historic/2003/pycon/conch/conch
View file
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@ from slides import Slide, Bullet, SubBullet, URL
from twslides import Lecture

lecture = Lecture(
"Twisted.Conch: SSH in Python",
"Twisted Conch: SSH in Python",
Slide("Introduction",
),
Slide("Other implementations (servers)",
8 changes: 4 additions & 4 deletions doc/historic/2003/pycon/conch/conch.html
View file
Original file line number Diff line number Diff line change
@@ -5,11 +5,11 @@
<html xmlns="http://www.w3.org/1999/xhtml">

<head>
<title>Twisted.Conch: SSH in Python with Twisted</title>
<title>Twisted Conch: SSH in Python with Twisted</title>
</head>

<body>
<h1>Twisted.Conch: SSH in Python with Twisted</h1>
<h1>Twisted Conch: SSH in Python with Twisted</h1>

<ul>
<li>Paul Swartz
@@ -18,7 +18,7 @@ <h1>Twisted.Conch: SSH in Python with Twisted</h1>

<h2>Introduction</h2>

<p>Although it is a newcomer on the Secure Shell stage, Twisted.Conch has quickly
<p>Although it is a newcomer on the Secure Shell stage, Twisted Conch has quickly
caught up with the two most popular free *nix implementations and the most
popular free Windows implementation in terms of functionality. This rapid
development time, as well as the stability and other advantages, owes much to
@@ -153,7 +153,7 @@ <h2>Future Directions</h2>
be interesting to see what it can be used for. Also important are auditing of
the code and increasing the speed. These will make the code more useful in
general, as well as improving security. Other ideas include direct support for
SFTP/SCP, support for a key agent, and interfacing with Twisted.Names to
SFTP/SCP, support for a key agent, and interfacing with Twisted Names to
support DNSSEC.</p>

<h2>Conclusion</h2>
4 changes: 2 additions & 2 deletions doc/historic/2003/pycon/conch/conchtalk.txt
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Introduction
------------
Although it is a newcomer on the Secure Shell stage, Twisted.Conch has quickly
Although it is a newcomer on the Secure Shell stage, Twisted Conch has quickly
caught up with the two most popular free *nix implementations and the most
popular free Windows implementation in terms of functionality. This rapid
development time, as well as the stability and other advantages, owes much to
@@ -134,7 +134,7 @@ more work with applications. Insults is becoming more powerful, and it will
be interesting to see what it can be used for. Also important are auditing of
the code and increasing the speed. These will make the code more useful in
general, as well as improving security. Other ideas include direct support for
SFTP/SCP, support for a key agent, and interfacing with Twisted.Names to
SFTP/SCP, support for a key agent, and interfacing with Twisted Names to
support DNSSEC.

Conclusion
2 changes: 1 addition & 1 deletion doc/historic/2003/pycon/releasing/releasing.html
View file
Original file line number Diff line number Diff line change
@@ -210,7 +210,7 @@ <h3>Transactions</h3>
<dd>

checks out the latest revision of Twisted from CVS and puts it in
the <q>Twisted.CVS</q> directory.
the <q>Twisted CVS</q> directory.

</dd>

2 changes: 1 addition & 1 deletion doc/historic/index.xhtml
View file
Original file line number Diff line number Diff line change
@@ -59,7 +59,7 @@ historical value intact.</p>
distribution, a domain name server and client API, and one, Pynfo, which
is packaged separately, a network information robot.</p></dd>

<dt><a href="2003/pycon/conch/conch.html"><cite>Twisted.Conch&#58; SSH in Python with Twisted</cite></a></dt>
<dt><a href="2003/pycon/conch/conch.html"><cite>Twisted Conch&#58; SSH in Python with Twisted</cite></a></dt>

<dd><p>Conch is an implementation of the Secure Shell Protocol (currently
in the IETF standarization process). Secure Shell (or SSH) is a popular
2 changes: 1 addition & 1 deletion doc/historic/ipc10paper.html
View file
Original file line number Diff line number Diff line change
@@ -1555,7 +1555,7 @@ <h3>References</h3>
<li>Using Spreadable Web Servers,
http://www.twistedmatrix.com/users/jh.twistd/python/moin.cgi/TwistedWeb</li>

<li>Twisted.Spread implementations for other languages,
<li>Twisted Spread implementations for other languages,
http://www.twistedmatrix.com/users/washort/</li>

<li>PHP: Hypertext Preprocessor, http://www.php.net/</li>
115 changes: 115 additions & 0 deletions doc/index.xhtml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Twisted Documentation Index</title></head><body>
<h1>Twisted Documentation Index</h1>

<ul>
<li>
<a href="core/index.xhtml">Twisted Core</a>
<ul>
<li>
<a href="core/howto/index.xhtml">Developer guides</a>
</li>
<li>
<a href="core/examples/index.xhtml">Twisted code examples</a>
</li>
<li>
<a href="core/specifications/index.xhtml">Specifications</a>
</li>
<li>
<a href="core/development/index.xhtml">Development of Twisted</a>
</li>
<li>
<a href="http://twistedmatrix.com/documents/current/api/">API reference</a>
</li>
</ul>
</li>
<li>
<a href="conch/index.xhtml">Twisted Conch</a>
<ul>
<li>
<a href="conch/howto/index.xhtml">Twisted Conch documentation</a>
</li>
<li>
<a href="conch/examples/index.xhtml">Twisted Conch code examples</a>
</li>
</ul>
</li>
<li>
<a href="lore/index.xhtml">Twisted Lore</a>
<ul>
<li>
<a href="lore/howto/index.xhtml">Twisted Lore documentation</a>
</li>
<li>
<a href="lore/examples/index.xhtml">Twisted Lore examples</a>
</li>
</ul>
</li>
<li>
<a href="mail/index.xhtml">Twisted Mail</a>
<ul>
<li>
<a href="mail/tutorial/smtpclient/smtpclient.xhtml">Twisted Mail tutorial</a>
</li>
<li>
<a href="mail/examples/index.xhtml">Twisted Mail code examples</a>
</li>
</ul>
</li>
<li>
<a href="names/index.xhtml">Twisted Names</a>
<ul>
<li>
<a href="names/howto/index.xhtml">Twisted Names documentation</a>
</li>
<li>
<a href="names/examples/index.xhtml">Twisted Names code examples</a>
</li>
</ul>
</li>
<li>
<a href="pair/index.xhtml">Twisted Pair</a>
<ul>
<li>
<a href="pair/howto/index.xhtml">Twisted Pair documentation</a>
</li>
<li>
<a href="pair/examples/index.xhtml">Twisted Pair code examples</a>
</li>
</ul>
</li>
<li>
<a href="web/index.xhtml">Twisted Web</a>
<ul>
<li>
<a href="web/howto/index.xhtml">Twisted Web documentation</a>
</li>
<li>
<a href="web/examples/index.xhtml">Twisted Web code examples</a>
</li>
</ul>
</li>
<li>
<a href="words/index.xhtml">Twisted Words</a>
<ul>
<li>
<a href="words/howto/index.xhtml">Twisted Words documentation</a>
</li>
<li>
<a href="words/examples/index.xhtml">Twisted Words code examples</a>
</li>
</ul>
</li>
<li>
<a href="historic/index.xhtml">Historical Documents</a>
<ul>
<li>
<a href="historic/index.xhtml#id1">2003</a>
</li>
<li>
<a href="historic/index.xhtml#previously">Previously</a>
</li>
</ul>
</li>
</ul>

</body></html>
4 changes: 2 additions & 2 deletions doc/mail/examples/index.xhtml
View file
Original file line number Diff line number Diff line change
@@ -4,11 +4,11 @@

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Twisted.Mail code examples</title>
<title>Twisted Mail code examples</title>
</head>

<body>
<h1>Twisted.Mail code examples</h1>
<h1>Twisted Mail code examples</h1>

<h2>SMTP servers</h2>
<ul>
Loading
Oops, something went wrong.

0 comments on commit 2266ced

Please sign in to comment.