Improved documentation template and index page

This commit is contained in:
Bastian Kleineidam 2009-03-11 23:39:08 +01:00
parent e039a84303
commit 62b6d9f241
3 changed files with 33 additions and 43 deletions

View file

@ -49,7 +49,7 @@ copyright = u'2009, Bastian Kleineidam'
# built documents.
#
# The short X.Y version.
version = '5.1'
version = '5.0.2'
# The full version, including alpha/beta/rc tags.
release = version
@ -188,3 +188,6 @@ latex_documents = [
# If false, no module index is generated.
#latex_use_modindex = True
#def setup(app):
# app.add_config_value('foo', 'default', True)

View file

@ -1,9 +1,6 @@
.. meta::
:keywords: link, URL, validation, checking
The latest version of this document is available at
http://linkchecker.sourceforge.net/.
===============================
Check websites for broken links
===============================
@ -39,24 +36,6 @@ Features
- a (Fast)CGI web interface (requires HTTP server)
Download
========
Get it from the `LinkChecker download section`_.
.. _LinkChecker download section:
http://sourceforge.net/project/showfiles.php?group_id=1913
Requirements and installation instructions are located at the
`install documentation`_. To see what has changed between releases
look at the ChangeLog_.
.. _install documentation:
install.html
.. _ChangeLog:
http://linkchecker.git.sourceforge.net/git/gitweb.cgi?p=linkchecker;a=blob;f=ChangeLog.txt;hb=HEAD
Screenshots
===========
@ -68,21 +47,3 @@ Screenshots
| Commandline interface | GUI client | Web interface |
+------------------------------------+------------------------------------+------------------------------------+
Support
=======
The `SF tracker`_ allows submitting of bugs, patches
and requests.
.. _SF tracker:
http://sourceforge.net/tracker/?func=add&group_id=1913&atid=101913
Repository
==========
The `SF code page`_ hosts the development source code of LinkChecker.
.. _SF code page:
http://sourceforge.net/scm/?type=git&group_id=1913

View file

@ -8,20 +8,32 @@ img { border: 0; }
{% block rootrellink %}
<li><a href="{{ pathto('index') }}">Home </a> |&nbsp;</li>
<li><a href="{{ pathto('install') }}">Installation </a> |&nbsp;</li>
<li><a href="{{ pathto('upgrading') }}">Upgrading </a> |&nbsp;</li>
<li><a href="{{ pathto('documentation') }}">Documentation </a>|&nbsp;</li>
<li><a href="{{ pathto('other') }}">Other </a> </li>
<li><a href="{{ pathto('other') }}">Other link checkers </a> </li>
{% endblock %}
{% block relbar1 %}
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
{% if builder == 'html' %}
<div style="float:right;"><a
href="http://sourceforge.net/projects/linkchecker"><img
src="http://sflogo.sourceforge.net/sflogo.php?group_id=1913&type=13"
width="120" height="30" border="0"
alt="Get LinkChecker at SourceForge.net." /></a>
<!-- Piwik -->
<script type="text/javascript">
var pkBaseURL = (("https:" == document.location.protocol) ? "https:" : "http:") + "//apps.sourceforge.net/piwik/linkchecker/";
document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
</script><script type="text/javascript">
piwik_action_name = '';
piwik_idsite = 1;
piwik_url = pkBaseURL + "piwik.php";
piwik_log(piwik_action_name, piwik_idsite, piwik_url);
</script>
<object><noscript><p><img src="http://apps.sourceforge.net/piwik/linkchecker/piwik.php?idsite=1" alt="piwik"/></p></noscript></object>
<!-- End Piwik Tag -->
</div>
{% endif %}
<table border="0"><tr>
<td><a href="{{ pathto('index') }}"><img
src="{{ pathto("_static/logo64x64.png", 1) }}" border="0" alt="LinkChecker"/></a></td>
@ -30,8 +42,22 @@ img { border: 0; }
</div>
{{ super() }}
{% endblock %}
{% block relbar2 %}{% endblock %}
{# put the sidebar before the body #}
{% block sidebarsearch %}{{ super() }}{% endblock %}
{% block sidebar1 %}{{ sidebar() }}{% endblock %}
{% block sidebar2 %}{% endblock %}
{% block sidebarlogo %}{% if builder == 'html' %}
{% if docname == 'index' %}
<h3>Download</h3>
<a href="http://prdownloads.sourceforge.net/linkchecker/LinkChecker-{{version}}.exe?download">LinkChecker&nbsp;{{version}}&nbsp;for&nbsp;Windows</a><br/>
<a href="http://prdownloads.sourceforge.net/linkchecker/LinkChecker-{{version}}.tar.gz?download">LinkChecker&nbsp;{{version}}&nbsp;source</a><br/>
<a href="http://linkchecker.git.sourceforge.net/git/gitweb.cgi?p=linkchecker;a=blob;f=ChangeLog.txt;hb=HEAD">Changelog</a><br/>
<h3>Support</h3>
<a href="http://sourceforge.net/tracker/?func=add&group_id=1913&atid=101913">Bug&nbsp;tracker</a><br/>
<a href="http://sourceforge.net/scm/?type=git&group_id=1913">Development&nbsp;repository</a><br/>
{% endif %}
{% endif %}
{% endblock %}
{% block sidebartoc %}{% endblock %}