Skip to content

Commit 9040caa

Browse files
author
Stefan Scherfke
committed
Improve/fix documentation home page for readthedocs.
1 parent fb9d79e commit 9040caa

File tree

7 files changed

+23
-66
lines changed

7 files changed

+23
-66
lines changed

docs/_static/simpy-logo-200px.png

-15.3 KB
Binary file not shown.

docs/_static/simpy-logo-banner.png

-20.7 KB
Binary file not shown.

docs/_static/simpy-logo-small.png

39 KB
Loading

docs/_templates/index.html

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,20 @@
1-
{% extends "layout.html" %}
2-
{% set title = 'Overview' %}
1+
{%- extends "layout.html" %}
2+
{%- set title = 'Overview' %}
33

4-
{% block body %}
5-
<h1>Welcome</h1>
4+
{%- block body %}
5+
<div style="margin: 0 0 .5em 1em; float: right;">
6+
<img src="_static/simpy-logo-small.png" style="width: 200px;">
7+
</div>
8+
9+
<h1>Welcome to SimPy</h1>
10+
11+
<p>Event discrete simulation for Python.</p>
12+
<p><a href="https://plus.google.com/101634625602509193865">News</a>
13+
<a href="https://pypi.python.org/pypi/simpy">PyPI</a>
14+
<a href="">Issues</a> |
15+
<a href="https://bitbucket.org/simpy/simpy/">Bitbucket</a> |
16+
<a href="https://lists.sourceforge.net/lists/listinfo/simpy-users">Users list</a> |
17+
<a href="https://lists.sourceforge.net/lists/listinfo/simpy-developer">Dev list</a></p>
618

719
<div style="margin: 0 0 .5em 1em; float: right;">
820
<div class="highlight-python"><div class="highlight"><pre style="padding-right: 2em;"><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">simpy</span>
@@ -91,4 +103,4 @@ <h2 style="clear: both;">Documentation</h2>
91103
</td>
92104
</tr>
93105
</table>
94-
{% endblock %}
106+
{%- endblock %}

docs/_templates/indexsidebar.html

Lines changed: 0 additions & 39 deletions
This file was deleted.

docs/_templates/layout.html

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/conf.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,12 @@
102102

103103
# The theme to use for HTML and HTML Help pages. See the documentation for
104104
# a list of builtin themes.
105-
html_theme = 'default'
105+
try:
106+
import sphinx_rtd_theme
107+
html_theme = 'sphinx_rtd_theme'
108+
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
109+
except ImportError:
110+
html_theme = 'default'
106111

107112
# Theme options are theme-specific and customize the look and feel of a theme
108113
# further. For a list of options available for each theme, see the
@@ -144,7 +149,6 @@
144149

145150
# Custom sidebar templates, maps document names to template names.
146151
#html_sidebars = {}
147-
html_sidebars = {'index': ['indexsidebar.html', 'searchbox.html']}
148152

149153
# Additional templates that should be rendered to pages, maps page names to
150154
# template names.

0 commit comments

Comments
 (0)