Add skeleton document generated with Sphinx.

.gitignore

@@ -90,3 +90,6 @@ ENV/
 
 # Rope project settings
 .ropeproject
+
+# Documentation artefacts
+doc/_build

README.rst

@@ -23,6 +23,20 @@ The project and releases are `registered on PyPI <http://pypi.python.org/pypi/sc
 The development is occurring at the
 `project's GitHub page <http://github.com/scikit-hep/scikit-hep>`_.
 
+Documentation
+-------------
+
+The documentation is hosted on the `Scikit-HEP website`_, and the source code
+is in the ``doc/`` folder. `Sphinx`_ is required for building the HTML pages,
+which can be done with the command:
+
+::
+
+    $ make -C doc html
+
+.. _Scikit-HEP website: http://scikit-hep.org/
+.. _Sphinx: http://www.sphinx-doc.org/en/stable/
+
 License
 -------
 The scikit-hep project is licensed under a 3-clause BSD style license - see the

doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = Scikit-HEP
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/_static/logo.svg

@@ -0,0 +1 @@
+../../for_talks/logo.svg

doc/_static/mathjax_conf.js

@@ -0,0 +1,18 @@
+/*
+ * This file configures MathJax, a JavaScript LaTeX renderer.
+ * Full configuration information can be found here:
+ *
+ *     http://docs.mathjax.org/en/latest/configuration.html
+ *
+ * Principally, this file defines macros that MathJax will expand. The
+ * TeX.Macros object maps macro names to LaTeX code.
+ */
+MathJax.Hub.Config({
+    TeX: {
+        Macros: {
+            rapidity: 'y',
+            pT: 'p_{\\mathrm{T}}',
+            decay: ['#1 \\to #2', 2]
+        }
+    }
+});

doc/_templates/layout.html

@@ -0,0 +1,7 @@
+{#
+  Jinja2 template file that extends the default Sphinx theme to include our
+  JavaScript file.
+#}
+{% extends "!layout.html" %}
+{% set script_files = script_files + ["_static/mathjax_conf.js"] %}
+{% set css_files = css_files + ["_static/scikit-hep.css"] %}

doc/about.rst

@@ -0,0 +1,19 @@
+About
+=====
+
+Words.
+
+Core team
+---------
+
+Words.
+
+Contributors
+------------
+
+Words.
+
+Licensing
+---------
+
+Words.

doc/affiliations.rst

@@ -0,0 +1,6 @@
+.. _affiliations:
+
+Affiliated packages
+===================
+
+Words.

doc/api/api.rst

@@ -0,0 +1,12 @@
+.. _api:
+
+API
+===
+
+.. automodule:: skhep
+  :no-members:
+  :no-inherited-members:
+
+.. toctree::
+   constants.rst
+   units.rst

doc/api/constants.rst

@@ -0,0 +1,7 @@
+.. _constants:
+
+Constants
+=========
+
+.. automodule:: skhep.constants
+   :members:

doc/api/units.rst

@@ -0,0 +1,10 @@
+.. _units:
+
+Units
+=====
+
+.. automodule:: skhep.units
+   :members:
+
+.. automodule:: skhep.units.prefixes
+   :members:

doc/conf.py

@@ -0,0 +1,168 @@
+# -*- coding: utf-8 -*-
+# Add the directory above this one, containing the skhep module, to the Python
+# PATH variable
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.autosummary'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Scikit-HEP'
+copyright = u'2017, The Scikit-HEP contributors'
+author = u'The Scikit-HEP contributors'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = u'0.0.0'
+# The full version, including alpha/beta/rc tags.
+release = u'0.0.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# 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.
+#
+html_sidebars = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',
+        'searchbox.html',
+        'donate.html',
+    ]
+}
+html_theme_options = {
+    'github_user': 'scikit-hep',
+    'github_repo': 'scikit-hep',
+    'github_type': 'star',
+    'logo': 'logo.svg',
+    'fixed_sidebar': True,
+    'show_powered_by': False,
+    # 'link': '#8b198b',
+    'font_family': 'Source Sans Pro',
+    'head_font_family': 'Source Serif Pro',
+    'code_font_family': 'Source Code Pro'
+}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Scikit-HEPdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'Scikit-HEP.tex', u'Scikit-HEP Documentation',
+     u'The Scikit-HEP contributors', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'scikit-hep', u'Scikit-HEP Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'Scikit-HEP', u'Scikit-HEP Documentation',
+     author, 'Scikit-HEP', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {
+    'https://docs.python.org/': None
+}

doc/contributing.rst

@@ -0,0 +1,36 @@
+.. _contributing:
+
+Contributing
+============
+
+If you already have an idea for a feature you'd like to see in *skhep*, you can start by seeing how to :ref:`contribute code <contributing_code>`.
+If not, we have :ref:`plenty of ideas <ideas>` we'd love to see!
+
+.. _contributing_code:
+
+Contributing code
+-----------------
+
+Words.
+
+Coding guidelines
+~~~~~~~~~~~~~~~~~
+
+Words.
+
+Suggesting new functionality
+----------------------------
+
+First check that the functionality does not already exist in :ref:`the API <api>`.
+
+.. _ideas:
+
+Ideas
+~~~~~
+
+Words.
+
+Feedback and bug reporting
+--------------------------
+
+Words.

doc/documentation.rst

@@ -0,0 +1,13 @@
+.. _documentation:
+
+Documentation
+====================
+
+This is the main page documentating the *skhep* module, example usage, and the user API.
+
+.. toctree::
+    :maxdepth: 2
+
+    examples/examples.rst
+    api/api.rst
+    faq.rst

doc/examples/examples.rst

@@ -0,0 +1,4 @@
+.. _examples:
+
+Examples
+========

doc/faq.rst

@@ -0,0 +1,4 @@
+.. _faq:
+
+Frequently asked questions
+==========================

doc/index.rst

@@ -0,0 +1,28 @@
+Welcome to Scikit-HEP's documentation!
+======================================
+
+To get started, first :ref:`install the skhep module <installation>` and then read the :ref:`main documentation <documentation>`.
+
+If there's a feature missing you'd like to see, you can :ref:`contribute to Scikit-HEP <contributing>` or check out the :ref:`list of affiliated packages <affiliations>`
+
+Here's some maths: :math:`\decay{D^{0}}{h^{+}h^{-}}`, and 
+:math:`\pT` and :math:`x`.
+
+.. toctree::
+   :hidden:
+   :maxdepth: 2
+
+   about.rst
+   installation.rst
+   documentation.rst
+   contributing.rst
+   affiliations.rst
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`