Merge pull request #1293 from hylang/docs-update

Get the documentation building again

CONTRIBUTING.rst

@@ -14,7 +14,7 @@ Pull requests are great! We love them; here is a quick guide:
 
 - Before contributing make sure you check the docs. There are two versions of docs available:
 
-  + `latest`_, for use with the bleeding-edge GitHub version.
+  + `master`_, for use with the bleeding-edge GitHub version.
 
   + `stable`_, for use with the PyPI version.
 
@@ -118,6 +118,6 @@ http://contributor-covenant.org/version/1/1/0/.
 .. _Fork the Repo: https://help.github.com/articles/fork-a-repo/
 .. _Start Here: http://rogerdudler.github.io/git-guide/
 .. _good-first-bug: https://github.com/hylang/hy/issues?q=is%3Aissue+is%3Aopen+label%3Agood-first-bug
-.. _latest: http://hylang.org/
+.. _master: http://docs.hylang.org/en/master/
-.. _stable: http://docs.hylang.org/en/stable/
+.. _stable: http://hylang.org/
 

README.md

@@ -40,9 +40,10 @@ Project
 -------
 
 * Code: https://github.com/hylang/hy
-* Docs (latest, for use with bleeding-edge github version): http://hylang.org/
+* Documentation:
-* Docs (stable, for use with the PyPI version): http://docs.hylang.org/en/stable/
+  * stable, for use with the latest stable release: http://hylang.org/
-* Quickstart: http://hylang.org/en/latest/quickstart.html
+  * master, for use with the latest revision on GitHub: http://docs.hylang.org/en/master
+* Quickstart: http://hylang.org/en/stable/quickstart.html
 * Bug reports: We have no bugs! Your bugs are your own! (https://github.com/hylang/hy/issues)
 * License: MIT (Expat)
 * [Contributor Guidelines & Code of Conduct](https://github.com/hylang/hy/blob/master/CONTRIBUTING.rst)

docs/_templates/breadcrumbs.html

@@ -0,0 +1,5 @@
+{% extends "!breadcrumbs.html" %}
+{% block breadcrumbs_aside %}
+  <li style="margin-left: 1em">Hy version {{ hy_descriptive_version }}</li>
+  {{ super() }}
+{% endblock %}

docs/conf.py

@@ -1,47 +1,18 @@
 # -*- coding: utf-8 -*-
 #
-# hy documentation build configuration file, created by
-# sphinx-quickstart on Tue Mar 12 22:52:58 2013.
-#
 # 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 os, sys, time, cgi
-import sys
-import time
 sys.path.append(os.path.abspath(".."))
 
-import hy
+from get_version import __version__ as hy_version
+if hy_version.endswith(".dirty"):
+    # Read the Docs might dirty its checkout, so ignore this.
+    hy_version = hy_version[:-len(".dirty")]
 
-# 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('.'))
-
-# -- 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']
-
-# Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
-
-# The suffix of source filenames.
 source_suffix = '.rst'
 
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
-# The master toctree document.
 master_doc = 'index'
 
 # General information about the project.
@@ -53,207 +24,28 @@ copyright = u'%s the authors' % time.strftime('%Y')
 # built documents.
 #
 # The short X.Y version.
-version = ".".join(hy.__version__.split(".")[:-1])
+version = ".".join(hy_version.split(".")[:-1])
 # The full version, including alpha/beta/rc tags.
-release = hy.__version__
+release = hy_version
+hy_descriptive_version = cgi.escape(hy_version)
+if "+" in hy_version:
+    hy_descriptive_version += " <strong style='color: red;'>(unstable)</strong>"
 
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
 exclude_patterns = ['_build', 'coreteam.rst']
 
-# The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
-# A list of ignored prefixes for module index sorting.
+import sphinx_rtd_theme
-#modindex_common_prefix = []
+html_theme = 'sphinx_rtd_theme'
-
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
-
-# -- Options for HTML output ---------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-try:
-    import sphinx_rtd_theme
-except ImportError:
-    html_theme = 'default'
-else:
-    html_theme = 'sphinx_rtd_theme'
-    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
-
-# 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 = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
-
-# The name for this set of Sphinx documents.  If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
 
 # 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']
 
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+html_use_smartypants = False
-# using the given strftime format.
+html_show_sphinx = False
-#html_last_updated_fmt = '%b %d, %Y'
 
-# If true, SmartyPants will be used to convert quotes and dashes to
+html_context = dict(
-# typographically correct entities.
+    hy_descriptive_version = hy_descriptive_version)
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_domain_indices = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it.  The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'hydoc'
-
-
-# -- 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': '',
-
-# Stuff for unicode characters
-  'utf8extra': r'''
-\DeclareUnicodeCharacter{2698}{FLOWER}
-\DeclareUnicodeCharacter{2665}{HEART}
-''',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
-latex_documents = [
-  ('index', 'hy.tex', u'hy Documentation',
-   u'Paul Tagliamonte', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# If true, show page references after internal links.
-#latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-#latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_domain_indices = True
-
-
-# -- Options for manual page output --------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
-    ('index', 'hy', u'hy Documentation',
-     [u'Paul Tagliamonte'], 1)
-]
-
-# If true, show URL addresses after external links.
-#man_show_urls = False
-
-
-# -- 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 = [
-  ('index', 'hy', u'hy Documentation',
-   u'Paul Tagliamonte', 'hy', 'One line description of project.',
-   'Miscellaneous'),
-]
-
-# Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
-
-# If false, no module index is generated.
-#texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'

docs/language/internals.rst

@@ -460,5 +460,4 @@ Checking Macro Arguments and Raising Exceptions
 Hy Compiler Built-Ins
 =====================
 
-.. todo::
+.. TODO: Write this.
-    Write this.

get_version.py

@@ -0,0 +1,20 @@
+import os, subprocess, runpy
+
+# Try to get and update the version.
+
+os.chdir(os.path.split(os.path.abspath(__file__))[0])
+VERSIONFILE = os.path.join("hy", "version.py")
+
+try:
+    __version__ = (subprocess.check_output
+                   (["git", "describe", "--tags", "--dirty"])
+                   .decode('ASCII').strip()
+                   .replace('-', '+', 1).replace('-', '.'))
+    with open(VERSIONFILE, "wt") as o:
+        o.write("__version__ = {!r}\n".format(__version__))
+
+except (subprocess.CalledProcessError, OSError):
+    if os.path.exists(VERSIONFILE):
+        __version__ = runpy.run_path(VERSIONFILE)['__version__']
+    else:
+        __version__ = "unknown"

setup.py

@@ -3,31 +3,16 @@
 # This file is part of Hy, which is free software licensed under the Expat
 # license. See the LICENSE.
 
-import os
+import sys, os
-import re
-import sys
-import runpy
-import subprocess
 
 from setuptools import find_packages, setup
 from setuptools.command.install import install
 
+from get_version import __version__
+
 os.chdir(os.path.split(os.path.abspath(__file__))[0])
 
 PKG = "hy"
-VERSIONFILE = os.path.join(PKG, "version.py")
-try:
-    __version__ = (subprocess.check_output
-        (["git", "describe", "--tags", "--dirty"])
-        .decode('ASCII').strip()
-        .replace('-', '+', 1).replace('-', '.'))
-    with open(VERSIONFILE, "wt") as o:
-        o.write("__version__ = {!r}\n".format(__version__))
-except (subprocess.CalledProcessError, OSError):
-    if os.path.exists(VERSIONFILE):
-        __version__ = runpy.run_path(VERSIONFILE)['__version__']
-    else:
-        __version__ = "unknown"
 
 long_description = """Hy is a Python <--> Lisp layer. It helps
 make things work nicer, and lets Python and the Hy lisp variant play