Merge ~jugmac00/lazr.delegates:publish-docs-on-rtd into lazr.delegates:main

[Jürgen Gmach]

Publish documentation on Read the Docs

[Colin Watson (cjwatson)]

review: Approve

diff --git a/.gitignore b/.gitignore
index 8271f5a..daeb903 100644
--- a/.gitignore
+++ b/.gitignore
@@ -13,3 +13,4 @@ __pycache__
 .coverage
 .tox
 *.pyc
+lazr/delegates/docs/_build
diff --git a/HACKING.rst b/CONTRIBUTING.rst
 similarity index 78%
 rename from HACKING.rst
 rename to CONTRIBUTING.rst
index 55984d8..5421a96 100644
--- a/HACKING.rst
+++ b/CONTRIBUTING.rst
@@ -23,6 +23,16 @@ please see the common hacking guidelines at:
     http://dev.launchpad.net/Hacking
 
 
+============
+Contributing
+============
+
+To run this project's tests, use `tox <https://tox.readthedocs.io/en/latest/>`_.
+
+To update the `project's documentation
+<https://lazrdelegates.readthedocs.io/en/latest/>`_ you need to trigger a manual
+build on the project's dashboard on https://readthedocs.org.
+
 Getting help
 ------------
 
@@ -37,15 +47,3 @@ If you want to discuss this package, join the team and mailing list here:
 or send a message to:
 
     [e-mail]
-
-
-Running the tests
-=================
-
-The tests suite requires tox_ and nose_ and is compatible with both Python 2
-and Python 3.  To run the full test suite::
-
-    $ tox
-
-.. _nose: https://nose.readthedocs.org/en/latest/
-.. _tox: https://testrun.org/tox/latest/
diff --git a/README.rst b/README.rst
index d7cdc5d..82e28dd 100644
--- a/README.rst
+++ b/README.rst
@@ -1,21 +1 @@
-=========================
 Welcome to lazr.delegates
-=========================
-
-Contents:
-
-.. toctree::
-   :maxdepth: 2
-
-   lazr/delegates/docs/usage
-   NEWS
-   HACKING
-
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/lazr/delegates/docs/CONTRIBUTING.rst b/lazr/delegates/docs/CONTRIBUTING.rst
 new file mode 120000
index 0000000..ac9338f
--- /dev/null
+++ b/lazr/delegates/docs/CONTRIBUTING.rst
@@ -0,0 +1 @@
+../../../CONTRIBUTING.rst
 \ No newline at end of file
diff --git a/lazr/delegates/docs/NEWS.rst b/lazr/delegates/docs/NEWS.rst
 new file mode 120000
index 0000000..c95df2b
--- /dev/null
+++ b/lazr/delegates/docs/NEWS.rst
@@ -0,0 +1 @@
+../../../NEWS.rst
 \ No newline at end of file
diff --git a/conf.py b/lazr/delegates/docs/conf.py
 similarity index 79%
 rename from conf.py
 rename to lazr/delegates/docs/conf.py
index 4b9d3d4..e6ba426 100644
--- a/conf.py
+++ b/lazr/delegates/docs/conf.py
@@ -11,9 +11,6 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-from __future__ import print_function
-import sys, os
-
 # 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.
@@ -38,19 +35,18 @@ source_suffix = '.rst'
 #source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'README'
+master_doc = 'index'
 
 # General information about the project.
-project = u'lazr.delegates'
-copyright = u'2013-2015, LAZR developers'
+project = 'lazr.delegates'
+copyright = '2013-2021, LAZR developers'
 
 # 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.
-with open('lazr/delegates/_version.py') as version_file:
-    exec(version_file.read())  # sets __version__
+from lazr.delegates import __version__
 version = __version__
 # The full version, including alpha/beta/rc tags.
 release = version
@@ -94,7 +90,7 @@ pygments_style = 'sphinx'
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+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
@@ -123,7 +119,7 @@ html_theme = 'default'
 # 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']
+html_static_path = []
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
@@ -134,8 +130,11 @@ html_static_path = ['_static']
 #html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
+html_sidebars = {
+    '**': [
+        'globaltoc.html',
+    ]
+}
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
 #html_additional_pages = {}
@@ -172,7 +171,7 @@ htmlhelp_basename = 'lazrdelegatesdoc'
 
 # -- Options for LaTeX output --------------------------------------------------
 
-latex_elements = {
+# latex_elements = {
 # The paper size ('letterpaper' or 'a4paper').
 #'papersize': 'letterpaper',
 
@@ -181,14 +180,10 @@ latex_elements = {
 
 # Additional stuff for the LaTeX preamble.
 #'preamble': '',
-}
+# }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
-latex_documents = [
-  ('index', 'lazrdelegates.tex', u'lazr.delegates Documentation',
-   u'LAZR developers', 'manual'),
-]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
@@ -215,10 +210,6 @@ latex_documents = [
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    ('index', 'lazrdelegates', u'lazr.delegates Documentation',
-     [u'LAZR developers'], 1)
-]
 
 # If true, show URL addresses after external links.
 #man_show_urls = False
@@ -229,11 +220,6 @@ man_pages = [
 # 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', 'lazrdelegates', u'lazr.delegates Documentation',
-   u'LAZR developers', 'lazrdelegates', 'One line description of project.',
-   'Miscellaneous'),
-]
 
 # Documents to append as an appendix to all manuals.
 #texinfo_appendices = []
@@ -242,27 +228,4 @@ texinfo_documents = [
 #texinfo_domain_indices = True
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
-
-# Make upload to packages.python.org happy.
-def index_html():
-    import errno
-    cwd = os.getcwd()
-    try:
-        try:
-            os.makedirs('build/sphinx/html')
-        except OSError as error:
-            if error.errno != errno.EEXIST:
-                raise
-        os.chdir('build/sphinx/html')
-        try:
-            os.symlink('README.html', 'index.html')
-            print('index.html -> README.html')
-        except OSError as error:
-            if error.errno != errno.EEXIST:
-                raise
-    finally:
-        os.chdir(cwd)
-
-import atexit
-atexit.register(index_html)
+#texinfo_show_urls = 'footnote'
 \ No newline at end of file
diff --git a/lazr/delegates/docs/usage.rst b/lazr/delegates/docs/index.rst
 similarity index 97%
 rename from lazr/delegates/docs/usage.rst
 rename to lazr/delegates/docs/index.rst
index 82dc85e..b593f9e 100644
--- a/lazr/delegates/docs/usage.rst
+++ b/lazr/delegates/docs/index.rst
@@ -134,3 +134,10 @@ the expected interfaces.
     True
     >>> IFoo2.providedBy(s)
     True
+
+
+.. toctree::
+
+    self
+    Contributing <CONTRIBUTING>
+    News <NEWS>
diff --git a/setup.py b/setup.py
index 0bdcee8..f0fe050 100755
--- a/setup.py
+++ b/setup.py
@@ -61,6 +61,9 @@ delegating behavior.
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
         ],
+        extras_require={
+            "docs": ["Sphinx"],
+        },
     # nose plugins don't really work with `python setup.py test` so use
     # `python setup.py nosetests` instead, or just `tox`.  Gosh, we really
     # should switch to nose2. :/  - BAW 2014-08-20
diff --git a/tox.ini b/tox.ini
index 9afcac5..76a9117 100644
--- a/tox.ini
+++ b/tox.ini
@@ -3,3 +3,11 @@ envlist = py27,py32,py33,py34,py35,py36,py37,py38
 
 [testenv]
 commands = python setup.py nosetests
+
+[testenv:docs]
+basepython =
+    python3
+commands =
+    sphinx-build -b html -d lazr/delegates/docs/_build/doctrees lazr/delegates/docs lazr/delegates/docs/_build/html
+deps =
+    .[docs]