summaryrefslogtreecommitdiff
path: root/doc/_templates
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2010-02-28 23:12:00 +0100
committerGeorg Brandl <georg@python.org>2010-02-28 23:12:00 +0100
commit5c16aebcc7736f7e66d14ba78133a93e912a46a8 (patch)
treebae35776ecf6c9dbd1b81369d3077ac5fd5a144f /doc/_templates
parent81c09bed619f2ad9f5d1bf09cb34b1c25d226f5e (diff)
downloadsphinx-5c16aebcc7736f7e66d14ba78133a93e912a46a8.tar.gz
Update blurb in setup.py and on the index page, link directly to tutorial.rst from index.
Diffstat (limited to 'doc/_templates')
-rw-r--r--doc/_templates/index.html71
1 files changed, 37 insertions, 34 deletions
diff --git a/doc/_templates/index.html b/doc/_templates/index.html
index a68a6251..082a1f87 100644
--- a/doc/_templates/index.html
+++ b/doc/_templates/index.html
@@ -4,7 +4,7 @@
<h1>Welcome</h1>
<div class="quotebar">
- <p>What users say:</p>
+ <p><em>What users say:</em></p>
<p>&ldquo;Cheers for a great tool that actually makes programmers <b>want</b>
to write documentation!&rdquo;</p>
</div>
@@ -12,28 +12,30 @@
<p>
Sphinx is a tool that makes it easy to create intelligent and beautiful
documentation, written by Georg Brandl and licensed under the BSD license.</p>
- <p>It was originally created to translate <a href="http://docs.python.org/dev/">the
- new Python documentation</a>, and it has excellent support for the documentation
- of Python projects, but other documents can be written with it too. Of course,
- this site is also created from reStructuredText sources using Sphinx!
+ <p>It was originally created for <a href="http://docs.python.org/dev/">the
+ new Python documentation</a>, and it has excellent facilities for the
+ documentation of Python projects, but C/C++ is already supported as well,
+ and it is planned to add special support for other languages as well. Of
+ course, this site is also created from reStructuredText sources using
+ Sphinx!
</p>
<p>
- It is still under constant development, and the following features are
- already present, work fine and can be seen &#8220;in action&#8221; in the
- Python docs:
+ Sphinx is under constant development. The following features are present,
+ work fine and can be seen &#8220;in action&#8221; in the Python docs:
</p>
<ul>
- <li><b>Output formats:</b> HTML (including Windows HTML Help) and LaTeX, for
- printable PDF versions</li>
+ <li><b>Output formats:</b> HTML (including Windows HTML Help), LaTeX (for
+ printable PDF versions), manual pages, plain text</li>
<li><b>Extensive cross-references:</b> semantic markup and automatic links
- for functions, classes, glossary terms and similar pieces of information</li>
+ for functions, classes, citations, glossary terms and similar pieces of
+ information</li>
<li><b>Hierarchical structure:</b> easy definition of a document tree, with
- automatic links to siblings, parents and children</li>
+ automatic links to siblings, parents and children</li>
<li><b>Automatic indices:</b> general index as well as a module index</li>
<li><b>Code handling:</b> automatic highlighting using the <a
- href="http://pygments.org">Pygments</a> highlighter</li>
+ href="http://pygments.org">Pygments</a> highlighter</li>
<li><b>Extensions:</b> automatic testing of code snippets, inclusion of
- docstrings from Python modules, and more</li>
+ docstrings from Python modules (API docs), and more</li>
</ul>
<p>
Sphinx uses <a href="http://docutils.sf.net/rst.html">reStructuredText</a>
@@ -42,39 +44,40 @@
suite, the <a href="http://docutils.sf.net/">Docutils</a>.
</p>
- <h2>Examples</h2>
- <p>
- The <a href="http://docs.python.org/dev/">Python documentation</a> and
- this page are different examples of Sphinx in use.
- You can also download PDF versions of the Sphinx documentation:
- a <a href="http://sphinx.pocoo.org/sphinx.pdf">version</a> generated from
- the LaTeX Sphinx produces, and a
- <a href="http://sphinx.pocoo.org/sphinx-rst2pdf.pdf">version</a> generated by rst2pdf.
- </p>
- <p>
- For examples of how Sphinx source files look, use the &#8220;Show source&#8221;
- links on all pages of the documentation apart from this welcome page.
- </p>
- <p>Links to more documentation generated with Sphinx can be found on the
- <a href="{{ pathto("examples") }}">Projects using Sphinx</a> page.
- </p>
-
<h2>Documentation</h2>
<table class="contentstable" align="center" style="margin-left: 30px"><tr>
<td width="50%">
+ <p class="biglink"><a class="biglink" href="{{ pathto("tutorial") }}">First steps with Sphinx</a><br/>
+ <span class="linkdescr">overview of basic tasks</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("contents") }}">Contents</a><br/>
<span class="linkdescr">for a complete overview</span></p>
+ </td><td width="50%">
<p class="biglink"><a class="biglink" href="{{ pathto("search") }}">Search page</a><br/>
<span class="linkdescr">search the documentation</span></p>
- </td><td width="50%">
<p class="biglink"><a class="biglink" href="{{ pathto("genindex") }}">General Index</a><br/>
<span class="linkdescr">all functions, classes, terms</span></p>
- <p class="biglink"><a class="biglink" href="{{ pathto("modindex") }}">Module Index</a><br/>
- <span class="linkdescr">quick access to all documented modules</span></p>
</td></tr>
</table>
+ <p>
+ You can also download PDF versions of the Sphinx documentation:
+ a <a href="http://sphinx.pocoo.org/sphinx.pdf">version</a> generated from
+ the LaTeX Sphinx produces, and
+ a <a href="http://sphinx.pocoo.org/sphinx-rst2pdf.pdf">version</a> generated
+ by rst2pdf.
+ </p>
+
+ <h2>Examples</h2>
+ <p>Links to documentation generated with Sphinx can be found on the
+ <a href="{{ pathto("examples") }}">Projects using Sphinx</a> page.
+ </p>
+ <p>
+ For examples of how Sphinx source files look, use the &#8220;Show
+ source&#8221; links on all pages of the documentation apart from this
+ welcome page.
+ </p>
+
<p>You may also be interested in the very nice
<a href="http://matplotlib.sourceforge.net/sampledoc/">tutorial</a> on how to
create a customized documentation using Sphinx written by the matplotlib