Merge 2b6754a into 06f5a45

docs/conf.py

@@ -105,8 +105,8 @@
 
 # Please update these texts to match the name of your package.
 html_theme_options = {
-    'logotext1': 'package',  # white,  semi-bold
-    'logotext2': '-template',  # orange, light
+    'logotext1': 'dust_',  # white,  semi-bold
+    'logotext2': 'extinction',  # orange, light
     'logotext3': ':docs'   # white,  light
     }
 
@@ -131,6 +131,10 @@
 # pixels large.
 #html_favicon = ''
 
+#  example from imexam
+#from os.path import join
+#html_favicon = join('_static', 'imexam.ico')
+
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
 #html_last_updated_fmt = ''
@@ -142,6 +146,13 @@
 # Output file base name for HTML help builder.
 htmlhelp_basename = project + 'doc'
 
+# more examples from imexam
+#html_logo = '_static/imexam_logo_trans.png'
+
+# Static files to copy after template files
+#html_static_path = ['_static']
+#html_style = 'imexam.css'
+
 
 # -- Options for LaTeX output -------------------------------------------------
 

docs/dust_extinction/extinguish.rst

@@ -0,0 +1,5 @@
+################################
+Extinguish or De-extinguish Data
+################################
+
+To be added

docs/dust_extinction/fit_extinction.rst

@@ -0,0 +1,5 @@
+#####################
+Fit Extinction Curves
+#####################
+
+To be added.

docs/dust_extinction/index.rst → docs/dust_extinction/model_flavors.rst

@@ -1,16 +1,12 @@
-Interstellar Dust Extinction
-============================
+#############
+Model Flavors
+#############
 
-Interstellar dust extinction curves implemnted as astropy models
+There are three differnet types of models: average, R(V)+ dependent prediction,
+and shape fitting.
 
-Uses the astropy affiliated package template
-
-Flavors of Models
-=================
-
-There are three differnet types of models (to be completed).
-
-1. Average models
+Average models
+==============
 
    These models provide averages from the literature with the ability to
    interpolate between the observed data points.
@@ -48,14 +44,8 @@ There are three differnet types of models (to be completed).
    plt.tight_layout()
    plt.show()
 
-2. Shape fitting models
-
-   These models are used to fit the detailed shape of dust extinction curves.
-
-   - FM90
-   - others needed (P92)
-
-3. R(V) (+ other variables) dependent prediction models
+R(V) (+ other variables) dependent prediction models
+====================================================
 
    These models provide predictions of the shape of the dust extinction
    given input variable(s).
@@ -64,21 +54,11 @@ There are three differnet types of models (to be completed).
    - F99 [function of R(V)]
    - others needed (GCC09, G16, etc)
 
-Repository
-==========
+Shape fitting models
+====================
 
-Github: <https://github.com/karllark/dust_extinction>
-
-Reference API
-=============
-.. toctree::
-   :maxdepth: 1
-
-.. automodapi:: dust_extinction.dust_extinction
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   These models are used to fit the detailed shape of dust extinction curves.
+
+   - FM90
+   - others needed (P92)
+

docs/dust_extinction/reference_api.rst

@@ -0,0 +1,2 @@
+.. automodapi:: dust_extinction.dust_extinction
+

docs/index.rst

@@ -1,17 +1,79 @@
-Documentation
-=============
+############################
+Interstellar Dust Extinction
+############################
+
+``dust_extinction`` is a python package to provide interstellar dust extinction
+curves.
+
+While there are other python packages that provide some of the extinction
+curves contained here, the explicit motivation for this package is to provide
+extinction curves to those using them to model/correct their data and those
+studying extinction curves directly to better undertand interstellar dust.
+
+This package is developed in the astropy affiliated package template and uses
+the astropy.modeling framework.
+
+Installation
+============
+
+To be added
+
+User Documenation
+=================
+
+.. toctree::
+   :maxdepth: 2
+
+   Flavors of Models <dust_extinction/model_flavors.rst>
+   Extinguish or de-extinguish data <dust_extinction/extinguish.rst>
+   Fit measured extinction curves <dust_extinction/fit_extinction.rst>
+
+
+Reporting Issues
+================
+
+If you have found a bug in ``dust_extinction`` please report it by creating a
+new issue on the ``dust_extinction`` `GitHub issue tracker
+<https://github.com/karllark/dust_extinction/issues>`_.
 
-This is an affiliated package for the AstroPy package. The documentation for
-this package is here:
+Please include an example that demonstrates the issue sufficiently so that
+the developers can reproduce and fix the problem. You may also be asked to
+provide information about your operating system and a full Python
+stack trace.  The developers will walk you through obtaining a stack
+trace if it is necessary.
 
+Contributing
+============
+
+Like the `Astropy`_ project, ``dust_extinction`` is made both by and for its
+users.  We accept contributions at all levels, spanning the gamut from
+fixing a typo in the documentation to developing a major new feature.
+We welcome contributors who will abide by the `Python Software
+Foundation Code of Conduct
+<https://www.python.org/psf/codeofconduct/>`_.
+
+``dust_extinction`` follows the same workflow and coding guidelines as
+`Astropy`_.  The following pages will help you get started with
+contributing fixes, code, or documentation (no git or GitHub
+experience necessary):
+
+* `How to make a code contribution <http://astropy.readthedocs.io/en/stable/development/workflow/development_workflow.html>`_
+
+* `Coding Guidelines <http://docs.astropy.io/en/latest/development/codeguide.html>`_
+
+* `Try the development version <http://astropy.readthedocs.io/en/stable/development/workflow/get_devel_version.html>`_
+
+* `Developer Documentation <http://docs.astropy.org/en/latest/#developer-documentation>`_
+
+
+For the complete list of contributors please see the `dust_extinction
+contributors page on Github
+<https://github.com/karllark/dust_extinction/graphs/contributors>`_.
+
+Reference API
+=============
 .. toctree::
-  :maxdepth: 2
+   :maxdepth: 1
 
-  dust_extinction/index.rst
+   dust_extinction/reference_api.rst
 
-.. note:: The layout of this directory is simply a suggestion.  To follow
-          traditional practice, do *not* edit this page, but instead place
-          all documentation for the affiliated package inside ``packagename/``.
-          The traditional practice was intended to allow the affiliated
-          package to eventually be merged into the main astropy package.
-          You can follow this practice or choose your own layout.