Stefan Scherfke avatar Stefan Scherfke committed afb0531

Improve/fix documentation home page for readthedocs.

Comments (0)

Files changed (7)

Add a comment to this file

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

Removed
Old image
Add a comment to this file

docs/_static/simpy-logo-banner.png

Removed
Old image
Add a comment to this file

docs/_static/simpy-logo-small.png

Added
New image

docs/_templates/index.html

-{% extends "layout.html" %}
-{% set title = 'Overview' %}
+{%- extends "layout.html" %}
+{%- set title = 'Overview' %}
 
-{% block body %}
-  <h1>Welcome</h1>
+{%- block body %}
+<div style="margin: 0 0 .5em 1em; float: right;">
+    <img src="_static/simpy-logo-small.png" style="width: 200px;">
+</div>
+
+<h1>Welcome to SimPy</h1>
+
+<p>Event discrete simulation for Python.</p>
+<p><a href="https://plus.google.com/101634625602509193865">News</a> | 
+   <a href="https://pypi.python.org/pypi/simpy">PyPI</a> | 
+   <a href="">Issues</a> |
+   <a href="https://bitbucket.org/simpy/simpy/">Bitbucket</a> |
+   <a href="https://lists.sourceforge.net/lists/listinfo/simpy-users">Users list</a> |
+   <a href="https://lists.sourceforge.net/lists/listinfo/simpy-developer">Dev list</a></p>
 
 <div style="margin: 0 0 .5em 1em; float: right;">
 <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>
         </td>
     </tr>
 </table>
-{% endblock %}
+{%- endblock %}

docs/_templates/indexsidebar.html

-<h3>Download</h3>
-{% if 'a' in version %}
-<p>This documentation is for version <b>{{ version }}</b>, which is not
-    released yet.</p>
-
-<p>You can use it from the <a
-    href="http://bitbucket.org/simpy/simpy/">Mercurial repo</a> or look for
-    released versions in the <a href="http://pypi.python.org/pypi/SimPy">Python
-    Package Index</a>.</p>
-{% else %}
-<p>Current version: <b>{{ release }}</b></p>
-<p>Get SimPy from the <a href="http://pypi.python.org/pypi/simpy">Python
-    Package Index</a>, or install it with:</p>
-<pre style="margin: 0 0 0.5em;">pip install -U simpy</pre>
-<p>You can find the latest development version at <a
-    href="https://bitbucket.org/simpy/simpy">Bitbucket</a>.</p>
-{% endif %}
-
-<h3>News</h3>
-<p>Follow us on Google+ to get the lates news.</p>
-<!-- Place this tag where you want the badge to render. -->
-<div class="g-plus" data-width="224" data-href="https://plus.google.com/101634625602509193865" data-rel="publisher"></div>
-<!-- Place this tag after the last badge tag. -->
-<script type="text/javascript">
-  (function() {
-    var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true;
-    po.src = 'https://apis.google.com/js/plusone.js';
-    var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s);
-  })();
-</script>
-
-<h3>Questions? Suggestions?</h3>
-<p>Join the <a href="mailto:simpy-users@lists.sourceforge.net">SimPy-Users mailing list</a></p>
-<!-- <form action="http://groups.google.com/group/sphinx-users/boxsubscribe" -->
-<!--       style="padding-left: 1em"> -->
-<!--   <input type="text" name="email" value="your@email"/> -->
-<!--   <input type="submit" name="sub" value="Subscribe" /> -->
-<!-- </form> -->
-<p>You can also open an issue at the <a href="http://www.bitbucket.org/simpy/simpy/issues/">tracker</a></p>

docs/_templates/layout.html

-{# Read the docs doesn't use this file!! :-( #}
-{% extends "!layout.html" %}
-
-{% block extrahead %}
-{{ super() }}
-{# <style type="text/css"> #}
-{# .floatright pre { #}
-{#     margin: 0; #}
-{#     border: 1px solid; #}
-{#     border-radius: 4px; #}
-{# } #}
-{# </style> #}
-{% endblock %}
-
-{% block rootrellink %}
-    <li><a href="{{ pathto('index') }}">SimPy home</a>&nbsp;&nbsp;|&nbsp;</li>
-    {{ super() }}
-    {# <li><a href="{{ pathto('contents') }}">Documentation</a> #}
-    {#   &raquo;</li> #}
-{% endblock %}
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+try:
+    import sphinx_rtd_theme
+    html_theme = 'sphinx_rtd_theme'
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+except ImportError:
+    html_theme = 'default'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 
 # Custom sidebar templates, maps document names to template names.
 #html_sidebars = {}
-html_sidebars = {'index': ['indexsidebar.html', 'searchbox.html']}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.