Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

First Draft of Trac migration to Pelican #2

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

First Draft of Trac migration to Pelican #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
362dbcc
First Draft of Trac migration to Pelican
JudgeGregg Sep 25, 2021
02fd80b
Add WebDevelopmentWithTwisted page
JudgeGregg Sep 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions archives.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Test Twisted Trac Wiki - Archives</title>
<meta charset="utf-8" />
<meta name="generator" content="Pelican" />

<meta name="Description" content="An event-driven networking engine written in Python and MIT licensed." />

<link rel="stylesheet" type="text/css" href="https://twisted.org/theme/css/twistedtrac.css" />
</head>

<body>
<div id="banner">
<div id="top_grad"></div>
<div id="tab">
<a href="https://twistedmatrix.com/trac/wiki">HOME</a>
<a href="https://twistedmatrix.com/trac/wiki/FrequentlyAskedQuestions">FAQ</a>
<a href="/">DOCS</a>
<a href="https://twistedmatrix.com/trac/wiki/Downloads">DOWNLOAD</a>
</div>

<div id="header">
<a id="logo" href="https://twisted.org/"><img src="https://twisted.org/theme/images/trac_banner.png" alt="Twisted" /></a>
</div>
</div>

<h1>Archives for Test Twisted Trac Wiki</h1>

<dl>
</dl>

<div id="footer"><hr>
<div> </div>
<p class="left2">
Copyright 2021, Twisted Matrix Labs. Ver 21.2.0. Built on 2021-02-28.<br />
Site design<br />
By <a href="http://huw.ugbox.net/">huw.wilkins.</a>

</p>
<p class="right"></p>
</div>


</body>
</html>
45 changes: 45 additions & 0 deletions authors.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Test Twisted Trac Wiki - Authors</title>
<meta charset="utf-8" />
<meta name="generator" content="Pelican" />

<meta name="Description" content="An event-driven networking engine written in Python and MIT licensed." />

<link rel="stylesheet" type="text/css" href="https://twisted.org/theme/css/twistedtrac.css" />
</head>

<body>
<div id="banner">
<div id="top_grad"></div>
<div id="tab">
<a href="https://twistedmatrix.com/trac/wiki">HOME</a>
<a href="https://twistedmatrix.com/trac/wiki/FrequentlyAskedQuestions">FAQ</a>
<a href="/">DOCS</a>
<a href="https://twistedmatrix.com/trac/wiki/Downloads">DOWNLOAD</a>
</div>

<div id="header">
<a id="logo" href="https://twisted.org/"><img src="https://twisted.org/theme/images/trac_banner.png" alt="Twisted" /></a>
</div>
</div>

<h1>Authors on Test Twisted Trac Wiki</h1>
<ul>
</ul>

<div id="footer"><hr>
<div> </div>
<p class="left2">
Copyright 2021, Twisted Matrix Labs. Ver 21.2.0. Built on 2021-02-28.<br />
Site design<br />
By <a href="http://huw.ugbox.net/">huw.wilkins.</a>

</p>
<p class="right"></p>
</div>


</body>
</html>
45 changes: 45 additions & 0 deletions categories.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Test Twisted Trac Wiki - Categories</title>
<meta charset="utf-8" />
<meta name="generator" content="Pelican" />

<meta name="Description" content="An event-driven networking engine written in Python and MIT licensed." />

<link rel="stylesheet" type="text/css" href="https://twisted.org/theme/css/twistedtrac.css" />
</head>

<body>
<div id="banner">
<div id="top_grad"></div>
<div id="tab">
<a href="https://twistedmatrix.com/trac/wiki">HOME</a>
<a href="https://twistedmatrix.com/trac/wiki/FrequentlyAskedQuestions">FAQ</a>
<a href="/">DOCS</a>
<a href="https://twistedmatrix.com/trac/wiki/Downloads">DOWNLOAD</a>
</div>

<div id="header">
<a id="logo" href="https://twisted.org/"><img src="https://twisted.org/theme/images/trac_banner.png" alt="Twisted" /></a>
</div>
</div>

<h1>Categories on Test Twisted Trac Wiki</h1>
<ul>
</ul>

<div id="footer"><hr>
<div> </div>
<p class="left2">
Copyright 2021, Twisted Matrix Labs. Ver 21.2.0. Built on 2021-02-28.<br />
Site design<br />
By <a href="http://huw.ugbox.net/">huw.wilkins.</a>

</p>
<p class="right"></p>
</div>


</body>
</html>
109 changes: 109 additions & 0 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Test Twisted Trac Wiki - Documentation</title>
<meta charset="utf-8" />
<meta name="generator" content="Pelican" />

<meta name="Description" content="An event-driven networking engine written in Python and MIT licensed." />

<link rel="stylesheet" type="text/css" href="https://twisted.org/theme/css/twistedtrac.css" />


</head>

<body>
<div id="banner">
<div id="top_grad"></div>
<div id="tab">
<a href="https://twistedmatrix.com/trac/wiki">HOME</a>
<a href="https://twistedmatrix.com/trac/wiki/FrequentlyAskedQuestions">FAQ</a>
<a href="/">DOCS</a>
<a href="https://twistedmatrix.com/trac/wiki/Downloads">DOWNLOAD</a>
</div>

<div id="header">
<a id="logo" href="https://twisted.org/"><img src="https://twisted.org/theme/images/trac_banner.png" alt="Twisted" /></a>
</div>
</div>

<div id="mainnav" class="related">
<ul>
<li><a href="https://twisted.org">Twisted 21.2.0 documentation</a> »</li>
</ul>
</div>
<div id="ctxtnav" class="nav">
</div>

<section>

<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<h1>Documentation</h1>

<div class="entry-content">
<p><a class="reference external" href="http://twistedmatrix.com/documents/current/core/howto/index.html"><strong>Start here</strong></a> , the developer guides for Twisted's core networking libraries. See also our many <a class="reference external" href="http://twistedmatrix.com/documents/current/core/examples/">examples</a> and the current <a class="reference external" href="http://twistedmatrix.com/documents/current/api/">API reference</a>.</p>
<p><a class="reference external" href="http://twistedmatrix.com/documents/current/web/howto/">Web Servers and Clients howtos</a> and <a class="reference external" href="http://twistedmatrix.com/documents/current/web/examples/">examples</a> . Want to use Twisted for <strong>web development</strong>? Please read <a class="reference external" href="https://twisted.org/pages/WebDevelopmentWithTwisted.html">this page first!</a></p>
<ul class="simple">
<li>Read our <a class="reference external" href="https://twisted.org/pages/FrequentlyAskedQuestions.html">FAQ</a>.</li>
<li>Documentation for other Twisted components:<ul>
<li>SSH Servers and Clients - <a class="reference external" href="http://twistedmatrix.com/documents/current/conch/howto/">howtos</a> and <a class="reference external" href="http://twistedmatrix.com/documents/current/conch/examples/">examples</a>.</li>
<li>Email protocols: SMTP, IMAP, POP3 - <a class="reference external" href="http://twistedmatrix.com/documents/current/mail/tutorial/smtpclient/smtpclient.html">STMP client tutorial</a> and <a class="reference external" href="http://twistedmatrix.com/documents/current/mail/examples/">examples</a>.</li>
<li>DNS - <a class="reference external" href="http://twistedmatrix.com/documents/current/names/howto/">howtos</a> and <a class="reference external" href="http://twistedmatrix.com/documents/current/names/examples/">examples</a>.</li>
<li>Instant messaging and IRC - <a class="reference external" href="http://twistedmatrix.com/documents/current/words/howto/">howtos</a> and <a class="reference external" href="http://twistedmatrix.com/documents/current/words/examples/">examples</a>.</li>
</ul>
</li>
<li>Twisted Core <a class="reference external" href="http://twistedmatrix.com/documents/current/core/man/">man pages</a>.</li>
<li>The complete developer guide in <a class="reference external" href="https://media.readthedocs.org/pdf/twisted/latest/twisted.pdf">PDF format</a>.</li>
</ul>
<div class="section" id="third-party-documentation">
<h2>Third Party Documentation</h2>
<p>Dave Peticolas has written a number of <a class="reference external" href="http://krondo.com/?page_id=1327">excellent tutorials</a> on Twisted. They don't assume a lot of existing knowledge about networking or concurrency mechanisms, and as such are well-suited for new users.</p>
</div>
<div class="section" id="developer-docs">
<h2>Developer Docs</h2>
<ul class="simple">
<li>Want to contribute? We have a page dedicated to <a class="reference external" href="https://twisted.org/pages/ContributingToTwisted.html">documentation for contributors</a>.</li>
<li>Here are some notes about <a class="reference external" href="https://twisted.org/pages/TwistedDevelopment.html">Twisted Development</a>.</li>
</ul>
</div>
<div class="section" id="mail-lists">
<h2>Mail Lists</h2>
<ul class="simple">
<li>Search the <a class="reference external" href="http://www.mail-archive.com/twisted&#64;python.org">twisted</a> or <a class="reference external" href="http://www.google.com/search?q=site%3Atwistedmatrix.com+inurl%3Apipermail%2Ftwisted-web&amp;btnG=Search">twisted-web</a> mail list archives.</li>
</ul>
</div>
<div class="section" id="books">
<h2>Books</h2>
<ul class="simple">
<li><a class="reference external" href="http://www.amazon.com/exec/obidos/ASIN/1449326110/jpcalsjou-20">Twisted Network Programming Essentials</a> by Abe Fettig &amp; Jessica McKellar, published by O'Reilly.</li>
<li><a class="reference external" href="http://www.amazon.com/exec/obidos/ASIN/1590593715/jpcalsjou-20">Foundations of Python Network Programming</a> also covers the use of Twisted to some extent.</li>
<li><a class="reference external" href="http://www.amazon.com/exec/obidos/ASIN/1584502584/jpcalsjou-20">Game Programming With Python</a> covers Twisted in the chapters on programming networked games.</li>
</ul>
</div>

</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
</div>
</div> </div>

</section>

<div id="footer"><hr>
<div> </div>
<p class="left2">
Copyright 2021, Twisted Matrix Labs. Ver 21.2.0. Built on 2021-02-28.<br />
Site design<br />
By <a href="http://huw.ugbox.net/">huw.wilkins.</a>

</p>
<p class="right"></p>
</div>


</body>
</html>
91 changes: 91 additions & 0 deletions pages/APIDocs.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Test Twisted Trac Wiki - Twisted API Documentation</title>
<meta charset="utf-8" />
<meta name="generator" content="Pelican" />

<meta name="Description" content="An event-driven networking engine written in Python and MIT licensed." />

<link rel="stylesheet" type="text/css" href="https://twisted.org/theme/css/twistedtrac.css" />


</head>

<body>
<div id="banner">
<div id="top_grad"></div>
<div id="tab">
<a href="https://twistedmatrix.com/trac/wiki">HOME</a>
<a href="https://twistedmatrix.com/trac/wiki/FrequentlyAskedQuestions">FAQ</a>
<a href="/">DOCS</a>
<a href="https://twistedmatrix.com/trac/wiki/Downloads">DOWNLOAD</a>
</div>

<div id="header">
<a id="logo" href="https://twisted.org/"><img src="https://twisted.org/theme/images/trac_banner.png" alt="Twisted" /></a>
</div>
</div>

<div id="mainnav" class="related">
<ul>
<li><a href="https://twisted.org">Twisted 21.2.0 documentation</a> »</li>
</ul>
</div>
<div id="ctxtnav" class="nav">
</div>

<section>

<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<h1>Twisted API Documentation</h1>

<div class="entry-content">
<p>This page describes how to generate the API docs for the Twisted web site.</p>
<p>You will need the latest Twisted release unpacked and the latest version of pydoctor</p>
<div class="section" id="steps">
<h2>Steps</h2>
<ol class="arabic simple">
<li>Modify template.tpl to include the Google Analytics JavaScript (which can be found in the source of any trac page).</li>
<li>Run an interactive Python session that goes something like this:</li>
</ol>
<div class="highlight"><pre><span></span><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span> <span class="nn">twisted.python._release</span> <span class="kn">import</span> <span class="n">APIBuilder</span>
<span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span> <span class="nn">twisted.python.filepath</span> <span class="kn">import</span> <span class="n">FilePath</span>
<span class="o">&gt;&gt;&gt;</span> <span class="n">APIBuilder</span><span class="p">()</span><span class="o">.</span><span class="n">build</span><span class="p">(</span><span class="s1">&#39;Twisted&#39;</span><span class="p">,</span> <span class="s1">&#39;http://twistedmatrix.com/trac&#39;</span><span class="p">,</span>
<span class="s1">&#39;http://twistedmatrix.com/trac/browser/tags/releases/twisted-8.2.0&#39;</span><span class="p">,</span>
<span class="n">FilePath</span><span class="p">(</span><span class="s1">&#39;Twisted-8.2.0/twisted&#39;</span><span class="p">),</span> <span class="n">FilePath</span><span class="p">(</span><span class="s1">&#39;apidocs&#39;</span><span class="p">))</span>
</pre></div>
<p>Be sure to use the tag which corresponds to the version of Twisted the docs are being generated for. Note that if your working is the Twisted source directory you checked out, then ''that'' version of <cite>APIBuilder</cite> will be used!</p>
<ol class="arabic simple" start="3">
<li>Upload the resulting <tt class="docutils literal">apidocs</tt> directory to <a class="reference external" href="mailto:www-data&#64;cube">www-data&#64;cube</a>. Use <tt class="docutils literal">tar cx apidocs | ssh <span class="pre">www-data&#64;twistedmatrix.com</span> tar xv</tt> or something.</li>
<li>Put the apidocs directory into the appropriate location beneath vhosts/twistedmatrix.com/documents/ (eg 8.2.0/api)</li>
<li>If desired, update the <tt class="docutils literal">current</tt> symlink.</li>
</ol>
</div>

</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
</div>
</div> </div>

</section>

<div id="footer"><hr>
<div> </div>
<p class="left2">
Copyright 2021, Twisted Matrix Labs. Ver 21.2.0. Built on 2021-02-28.<br />
Site design<br />
By <a href="http://huw.ugbox.net/">huw.wilkins.</a>

</p>
<p class="right"></p>
</div>


</body>
</html>
Loading