Merge pull request #198 from adrn/better-header

Better header

Author: adrn

CONTRIBUTING.rst

@@ -28,11 +28,12 @@ Overview
 * Each tutorial should have 3–5 explicit `Learning Goals
   <http://tll.mit.edu/help/intended-learning-outcomes>`_, demonstrate ~2–3
   pieces of functionality relevant to astronomy, and 2–3 demonstrations of
-  generic but commonly used functionality (e.g., numpy, matplotlib)
+  generic but commonly used functionality (e.g., ``numpy``, ``matplotlib``)
 * Roughly follow this progression:
-    * *Intput/Output*: read in some data (use `astroquery
-      <https://astroquery.readthedocs.io/en/latest/>`_ where possible
-    * *Analysis*: do something insightful/useful with the data
+    * *Input/Output*: read in some data (use `astroquery
+      <https://astroquery.readthedocs.io/en/latest/>`_ where possible to query
+      real astronomical datasets)
+    * *Analysis*: do something insightful / useful with the data
     * *Visualization*: make a pretty figure (use `astropy.visualization
       <http://docs.astropy.org/en/stable/visualization/>`_ where possible)
 * The tutorials must be compatible with the versions supported by the last major
@@ -72,9 +73,9 @@ Narrative
   formatting, links, latex, and code snippets.
 * Title should be short yet descriptive and emphasize the learning goals of the
   tutorial. Try to make the title appeal to a broad audience and avoid
-  referencing a specefic instrument, catalog, or anything wavelength dependent.
-* List all author's full names (comma separated) and link to github profile
-  and/or `ORCID iD <https://orcid.org/>`_.
+  referencing a specific instrument, catalog, or anything wavelength dependent.
+* List all author's full names (comma separated) and link to GitHub profile
+  and/or `ORCID iD <https://orcid.org/>`_ when relevant.
 * Include `Learning Goals <http://tll.mit.edu/help/intended-learning-outcomes>`_
   at the top as a bulleted list.
 * Include Keywords as a comma separated list of topics, packages, and functions
@@ -97,22 +98,23 @@ Template intro
 
 .. code-block:: none
 
-    # Doing a thing with things
+    # Title name
 
     ## Authors
     Jane Smith, Jose Jones
 
-    ## Leaning Goals
-    - Query..
-    - Calculate..
-    - Display..
+    ## Learning Goals
+    * Query the ... dataset
+    * Calculate ...
+    * Display ...
 
     ## Keywords
     Example, example, example
 
     ## Companion Content
     Carroll & Ostlie 10.3, Binney & Tremaine 1.5
 
+    ## Summary
     In this tutorial, we download a data file, do something to it, and then
     visualize it.
 
@@ -126,7 +128,7 @@ concepts `branch, push, pull request <https://help.github.com/articles/proposing
 
 To contribute a new tutorial, first fork the ``astropy-tutorials`` repository.
 Then, clone your fork locally to your machine (replace <GITHUB USERNAME> with
-your github username)::
+your GitHub username)::
 
     git clone [email protected]:<GITHUB USERNAME>/astropy-tutorials.git
 
@@ -148,8 +150,8 @@ notebook file itself -- should go in this directory.
 
 Specify the python packages the tutorial depends on by creating a text file
 called ``requirements.txt`` in the same notebook directory. For example, if your
-tutorial requires scipy version 1.0 and numpy version 1.13 or greater, your
-``requirements.txt`` file would look like:
+tutorial requires ``scipy`` version 1.0 and ``numpy`` version 1.13 or greater,
+your ``requirements.txt`` file would look like:
 
 .. code-block:: none
 
@@ -158,15 +160,15 @@ tutorial requires scipy version 1.0 and numpy version 1.13 or greater, your
 
 To see an example, have a look at the FITS-header `requirements.txt file <https:
 //github.com/astropy/astropy-tutorials/blob/master/tutorials/notebooks/FITS-head
-er/requirements.json>`_.
+er/requirements.txt>`_.
 
 Push the notebook and other files from your local branch up to your fork of the
 repository on GitHub (by default, named 'origin')::
 
     git push origin Spectral-Line-Fitting
 
 When the tutorial is ready for broader community feedback, `open a pull request
-<https://help.github.com/articles/creating-a-pull-request/>`_against the main
+<https://help.github.com/articles/creating-a-pull-request/>`_ against the main
 ``astropy-tutorials`` repository in order for the community to review the new
 tutorial.
 

Makefile

@@ -37,6 +37,7 @@ clean:
 	-rm -rf $(BUILDDIR)
 	-rm -rf api
 	-rm -rf generated
+	-rm -rf tutorials/rst-tutorials
 
 html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

tutorials/_static/custom.css

@@ -7,6 +7,7 @@ div.body {
 
 div.body p {
     font-size: 15px;
+    line-height: 20px;
 }
 
 span.inputnumrole {
@@ -16,3 +17,18 @@ span.inputnumrole {
 span.outputnumrole {
     color: #D84315
 }
+
+button {
+    border-radius: 5px;
+    border-width: 0;
+    padding: 6px 10px 6px 10px;
+    cursor: pointer;
+    margin-right: 12px;
+    color: #ffffff;
+    font-size: 10pt;
+    background-image: linear-gradient(to bottom, #FFA47D 0%, #FF7D45 100%)
+}
+
+#spacer {
+    margin-top: 24px;
+}

tutorials/astropy.tpl

@@ -5,24 +5,30 @@
 {# Remove the exec_ prefix #}
 {% set nb_name = resources.metadata.name[5:] %}
 
-.. note::
-
-    This tutorial was generated from a Jupyter notebook that can be downloaded `here
-    <../_static/{{ nb_name }}/{{ nb_name }}.ipynb>`_.
-
-    You can interact with a live version of the source notebook through binder:
+.. raw:: html
 
-    |binder{{ nb_name }}|
+    <a href="../_static/{{ nb_name }}/{{ nb_name }}.ipynb"><button id="download">Download tutorial notebook</button></a>
+    <a href="https://beta.mybinder.org/v2/gh/astropy/astropy-tutorials/master?filepath=/tutorials/notebooks/{{ nb_name }}/{{ nb_name }}.ipynb"><button id="binder">Interactive tutorial notebook</button></a>
 
-.. |binder{{ nb_name }}| image:: http://mybinder.org/badge.svg
-   :target: https://beta.mybinder.org/v2/gh/astropy/astropy-tutorials/master?filepath=/tutorials/notebooks/{{ nb_name }}/{{ nb_name }}.ipynb
+    <div id="spacer"></div>
 
 .. role:: inputnumrole
 .. role:: outputnumrole
 
 .. _{{nb_name}}:
 {% endblock %}
 
+{% block footer %}
+
+.. raw:: html
+
+    <div id="spacer"></div>
+
+    <a href="../_static/{{ nb_name }}/{{ nb_name }}.ipynb"><button id="download">Download tutorial notebook</button></a>
+    <a href="https://beta.mybinder.org/v2/gh/astropy/astropy-tutorials/master?filepath=/tutorials/notebooks/{{ nb_name }}/{{ nb_name }}.ipynb"><button id="binder">Interactive tutorial notebook</button></a>
+
+{% endblock %}
+
 {% block in_prompt %}
 
 :inputnumrole:`In[{{  cell['execution_count'] }}]:`