Move the docs directory to Sphinx

Change the docs directory (which was just a directory of markdown files)
to a reStructuredText / Sphinx project.

Docs are reorganized by audience.

Some docs (for example embedding.rst) are copied over from the h repo's
docs. These will be removed from the h repo after this commit is merged.

.gitignore

@@ -1,3 +1,4 @@
 build/
 node_modules/
 coverage/
+docs/_build/

Makefile

@@ -19,6 +19,10 @@ test: node_modules/.uptodate
 lint: node_modules/.uptodate
 	npm run lint
 
+.PHONY: docs
+docs:
+	cd docs && make livehtml
+
 ################################################################################
 
 build/manifest.json: node_modules/.uptodate

docs/Makefile

@@ -0,0 +1,23 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = HypothesisClient
+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
+
+livehtml:
+	sphinx-autobuild -b dirhtml -p 8888 "$(SOURCEDIR)" "$(BUILDDIR)/dirhtml" $(SPHINXOPTS) $(O)
+
+# 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)

docs/_static/screenshot.png

@@ -0,0 +1 @@
+../../images/screenshot.png

docs/conf.py

@@ -0,0 +1,176 @@
+# -*- coding: utf-8 -*-
+#
+# Hypothesis Client documentation build configuration file, created by
+# sphinx-quickstart on Thu Mar  9 18:01:59 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import os
+# import sys
+
+from recommonmark.parser import CommonMarkParser
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# sys.path.insert(0, os.path.abspath('.'))
+
+# on_rtd is whether the docs are being built on readthedocs.org (or whether
+# someone is building them locally), this line of code grabbed from
+# docs.readthedocs.org
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+# -- 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.todo', 'sphinx.ext.intersphinx']
+
+intersphinx_mapping = {'h': ('https://h.readthedocs.io/en/latest/', None)}
+
+# Add any paths that contain tempates here, relative to this directory.
+templates_path = ['_templates']
+
+source_parsers = {
+    '.md': CommonMarkParser,  # Add Markdown support to Sphinx.
+}
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = ['.rst', '.md']
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Hypothesis Client'
+copyright = u'2017, Hypothesis Project Contributors'
+author = u'Hypothesis Project 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'1.0.0'
+# The full version, including alpha/beta/rc tags.
+release = u'1.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 = True
+
+numfig = True
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+if not on_rtd:  # only import and set the theme if we're building docs locally
+    import sphinx_rtd_theme
+    html_theme = 'sphinx_rtd_theme'
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# otherwise, readthedocs.org uses their theme by default, so no need to specify it
+
+# 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_theme_options = {
+    'display_version': False,
+}
+
+# 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 = 'HypothesisClientdoc'
+
+
+# -- 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, 'HypothesisClient.tex', u'Hypothesis Client Documentation',
+     u'Hypothesis Project 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, 'hypothesisclient', u'Hypothesis Client 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, 'HypothesisClient', u'Hypothesis Client Documentation',
+     author, 'HypothesisClient', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/developers/developing.rst

@@ -0,0 +1,158 @@
+Developing the Client
+=====================
+
+This section documents how to setup a development environment for the client,
+how to run the client and its tests in a development environment,
+client coding standards and how to contribute code to the client.
+
+Setting up a Client Development Environment
+-------------------------------------------
+
+Prerequisites
+#############
+
+You will need:
+
+* `git <https://git-scm.com/>`_
+* `Node.js <https://nodejs.org/en/>`_ v6+
+
+Building
+########
+
+To build the client for development:
+
+.. code-block:: sh
+
+   git clone 'https://github.com/hypothesis/client.git'
+   cd client
+   npm install -g gulp-cli  # Tip: if you get a "permission denied" error try
+                            # `sudo npm install -g gulp-cli` instead.
+   make
+
+You now have a development client built. To run your development client in
+a browser you'll need a local copy of either the Hypothesis Chrome extension or
+the Hypothesis web service. Follow either
+:ref:`running-from-browser-ext` or :ref:`running-from-web-service` below.
+If you're only interested in making changes to the client (and not to the web
+service) then running the client from the browser extension is easiest.
+
+
+.. _running-from-browser-ext:
+
+Running the Client from the Browser Extension
+---------------------------------------------
+
+This is the currently easiest way to get your development client running in a
+browser. It sets you up to make changes to the client and to the Chrome
+extension itself, but not to the web service.
+
+#. Check out the
+   `browser extension <https://github.com/hypothesis/browser-extension>`_
+   and follow the steps in the browser extension's documentation to build the
+   extension and configure it to use your local version of the client and the
+   production Hypothesis service.
+
+#. Start the client's development server to rebuild the client whenever it
+   changes:
+
+    .. code-block:: sh
+
+       gulp watch
+
+#. After making changes to the client, you will need to run ``make`` in the
+   browser extension repo and reload the extension in Chrome to see changes.
+   You can use
+   `Extensions Reloader <https://chrome.google.com/webstore/detail/extensions-reloader/fimgfedafeadlieiabdeeaodndnlbhid?hl=en>`_
+   to make this easier.
+
+.. _running-from-web-service:
+
+Running the Client From the Web Service
+---------------------------------------
+
+This takes longer to setup than :ref:`running-from-browser-ext`.
+You should follow these steps if you want to make changes to the Hypothesis
+web service as well as to the client.
+
+First follow the
+`instructions for setting up a development install of the web service <http://h.readthedocs.io/en/latest/developing/>`_.
+Once you have a development install of the Hypothesis service set up, you can
+configure it to use a local build of the client. **In the client repository**,
+run:
+
+.. code-block:: sh
+
+   export H_SERVICE_URL=http://localhost:5000
+   gulp watch
+
+**In the `hypothesis/h` repository**, set the :envvar:`CLIENT_URL` env var to
+tell the service where to load the client from, before running ``make dev``:
+
+.. code-block:: sh
+
+   export CLIENT_URL=http://localhost:3001/hypothesis
+   make dev
+
+Once the client and service are running, you can test it out by visiting:
+http://localhost:3000 or http://localhost:5000/docs/help in your browser.
+
+You can also load the client into your own web pages by adding:
+
+.. code-block:: html
+
+   <script async src="http://localhost:5000/embed.js"></script>
+
+to the page's HTML. Note that this will only work in pages served via plain
+HTTP.  If you want to test out the client on pages served via HTTPS then building
+the client into a browser extension is the easiest option.
+
+Running the Tests
+-----------------
+
+Hypothesis uses Karma and mocha for testing. To run all the tests once, run:
+
+.. code-block:: sh
+
+   gulp test
+
+To run tests and automatically re-run them whenever any source files change, run:
+
+.. code-block:: sh
+
+   gulp test-watch
+
+You can filter the tests which are run by passing ``--grep <pattern>`` as an
+argument to ``gulp test``. See the documentation for Mocha's
+`grep <https://mochajs.org/#g---grep-pattern>`_ option.
+
+Code Style
+----------
+
+JavaScript
+##########
+
+Hypothesis uses ESLint to help maintain style consistency. You can check your
+changes for conformance using:
+
+.. code-block:: sh
+
+   make lint
+
+Many lint errors can be fixed automatically using:
+
+.. code-block:: sh
+
+   ./node_modules/.bin/eslint --fix
+
+CSS
+###
+
+Styling is authored in SASS. For guidance on writing CSS for Hypothesis
+projects, please see our
+`CSS Guide <https://github.com/hypothesis/frontend-toolkit/blob/master/docs/css-style-guide.md>`_.
+
+Submitting Pull Requests
+------------------------
+
+For general guidance on submitting pull requests to Hypothesis projects, please
+see the `Contributor's Guide <https://h.readthedocs.io/en/latest/developing/>`_.

docs/developers/envvars.rst

@@ -0,0 +1,10 @@
+Environment Variables
+=====================
+
+This section documents all the environment variables supported by the client's
+build tasks.
+
+.. envvar:: H_SERVICE_URL
+
+   The URL of the service which hosts the HTML entry point for the client's
+   sidebar application.