Skip to content

Commit

Permalink
Updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dwysocki committed Jan 25, 2015
1 parent eb53a5e commit 527f2ed
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 3 deletions.
29 changes: 29 additions & 0 deletions docs/_static/scripts/utils.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
function getSnippet(id, url) {
var req = false;
// For Safari, Firefox, and other non-MS browsers
if (window.XMLHttpRequest) {
try {
req = new XMLHttpRequest();
} catch (e) {
req = false;
}
} else if (window.ActiveXObject) {
// For Internet Explorer on Windows
try {
req = new ActiveXObject("Msxml2.XMLHTTP");
} catch (e) {
try {
req = new ActiveXObject("Microsoft.XMLHTTP");
} catch (e) {
req = false;
}
}
}
var element = document.getElementById(id);
if (req) {
// Synchronous request, wait till we have it all
req.open('GET', url, false);
req.send(null);
element.innerHTML = req.responseText;
}
}
1 change: 0 additions & 1 deletion docs/_templates/layout.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
{% extends "!layout.html" %}


{% block rootrellink %}
<li><a href="{{ pathto('index') }}">home</a>|&nbsp;</li>
<li><a href="{{ pathto('search') }}">search</a>|&nbsp;</li>
Expand Down
5 changes: 4 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,8 @@

# -- Options for HTML output ----------------------------------------------

#html_index = "index.html"

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
import sphinx_readable_theme
Expand All @@ -121,6 +123,7 @@
html_theme = 'readable'



# 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
# documentation.
Expand All @@ -131,7 +134,7 @@

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
html_title = "plotypus: light curve analysis in Python"

# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
Expand Down
10 changes: 9 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ Installation
See `installation guide <user_guide/install.html>`_.


Download
--------

Visit the `plotypus downloads page </plotypus/downloads.html>`_.


Documentation
-------------

Expand All @@ -19,7 +25,7 @@ This is the documentation for version |version|.

<p id="other_versions"></p>
<script>
getSnippet('other_versions', '/versions.html');
getSnippet('other_versions', '/plotypus/versions.html');
</script>

Take a look through the `API <api/index.html>`_, the `User's Guide <user_guide/index.html>`_, and the `examples <examples/index.html>`_.
Expand All @@ -43,3 +49,5 @@ Contributing
We openly welcome outside contributions. If you would like to be a part of our team, feel free to contact us. If you find a bug, or would like to suggest a feature or improvement, please use our `issue tracker <https://github.com/astroswego/plotypus/issues>`_. If you would like to submit a patch, make a `pull request <https://github.com/astroswego/plotypus/pulls>`_.

We are currently looking for a volunteer to make a graphical user interface to plotypus. If you are interested please let us know, and due to the open nature of the project you can even make one without asking.


0 comments on commit 527f2ed

Please sign in to comment.