Merge pull request #520 from rtfd/docs2.0

Docs 2.0
readthedocs · Dec 21, 2017 · 1695f89 · 1695f89
2 parents 6278079 + 6392329
commit 1695f89
Show file tree

Hide file tree

Showing 20 changed files with 68 additions and 165 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -4,8 +4,16 @@ python:
   - 3.4
   - 3.5
   - 3.6
+matrix:
+  include:
+    - python: 2.7
+      env: TOXENV=docs
 sudo: false
 install:
   - pip install tox-travis
 script:
   - tox
+
+branches:
+  only:
+  - master
diff --git a/README.rst b/README.rst
@@ -16,12 +16,16 @@
 .. image:: https://img.shields.io/pypi/l/sphinx_rtd_theme.svg
    :target: https://pypi.python.org/pypi/sphinx_rtd_theme/
    :alt: license
+.. image:: https://readthedocs.org/projects/sphinx-rtd-theme/badge/?version=latest
+  :target: http://sphinx-rtd-theme.readthedocs.io/en/latest/?badge=latest
+  :alt: Documentation Status
 
 **************************
 Read the Docs Sphinx Theme
 **************************
 
 .. contents:: 
+   :backlinks: none
 
 View a working demo_ over on readthedocs.org_.
 

diff --git a/demo_docs/Makefile b/demo_docs/Makefile
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = ReadtheDocsSphinxTheme
+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)
diff --git a/demo_docs/source/conf.py → docs/conf.py b/demo_docs/source/conf.py → docs/conf.py
@@ -14,8 +14,11 @@
 import sys
 import os
 
-sys.path.append(os.path.abspath('.'))
-sys.path.append(os.path.abspath('./test_py_module'))
+
+sys.path.append(os.path.abspath('..'))
+sys.path.append(os.path.abspath('./demo/'))
+
+from sphinx_rtd_theme import __version__
 
 # 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
@@ -52,17 +55,17 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'Sphinx RTD theme demo'
-copyright = u'2013, Dave Snider'
+project = u'Read the Docs Sphinx Theme'
+copyright = u'Read the Docs, Inc & 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 = '0.2.4'
+version = __version__
 # The full version, including alpha/beta/rc tags.
-release = '0.2.4'
+release = __version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -126,7 +129,7 @@
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-html_logo = "static/logo-wordmark-light.svg"
+html_logo = "demo/static/logo-wordmark-light.svg"
 
 # 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

diff --git a/demo_docs/source/api.rst → docs/demo/api.rst b/demo_docs/source/api.rst → docs/demo/api.rst
diff --git a/demo_docs/source/demo.rst → docs/demo/demo.rst b/demo_docs/source/demo.rst → docs/demo/demo.rst
diff --git a/demo_docs/source/index.rst → docs/demo/index.rst b/demo_docs/source/index.rst → docs/demo/index.rst
@@ -1,7 +1,5 @@
-
-*****************************
-Read the Docs Theme Demo Docs
-*****************************
+Read the Docs Theme Demo
+************************
 
 These documents are used to test and stress test the Read the Docs Theme.
 

diff --git a/demo_docs/source/lists_tables.rst → docs/demo/lists_tables.rst b/demo_docs/source/lists_tables.rst → docs/demo/lists_tables.rst
diff --git a/demo_docs/source/long.rst → docs/demo/long.rst b/demo_docs/source/long.rst → docs/demo/long.rst
diff --git a/...ocs/source/static/logo-wordmark-light.svg → docs/demo/static/logo-wordmark-light.svg b/...ocs/source/static/logo-wordmark-light.svg → docs/demo/static/logo-wordmark-light.svg
diff --git a/demo_docs/source/static/screen_desktop.png → docs/demo/static/screen_desktop.png b/demo_docs/source/static/screen_desktop.png → docs/demo/static/screen_desktop.png
diff --git a/demo_docs/source/static/screen_mobile.png → docs/demo/static/screen_mobile.png b/demo_docs/source/static/screen_mobile.png → docs/demo/static/screen_mobile.png
diff --git a/demo_docs/source/static/yi_jing_01_chien.jpg → docs/demo/static/yi_jing_01_chien.jpg b/demo_docs/source/static/yi_jing_01_chien.jpg → docs/demo/static/yi_jing_01_chien.jpg
diff --git a/demo_docs/source/structure.rst → docs/demo/structure.rst b/demo_docs/source/structure.rst → docs/demo/structure.rst
diff --git a/demo_docs/source/test_py_module/__init__.py → docs/demo/test_py_module/__init__.py b/demo_docs/source/test_py_module/__init__.py → docs/demo/test_py_module/__init__.py
diff --git a/demo_docs/source/test_py_module/test.py → docs/demo/test_py_module/test.py b/demo_docs/source/test_py_module/test.py → docs/demo/test_py_module/test.py
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,13 @@
+
+.. include:: ../README.rst
+
+Content
+=======
+
+.. toctree::
+   :caption: Theme
+
+.. toctree::
+   :caption: Demo
+
+   demo/index
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,2 @@
+sphinxcontrib.httpdomain
+sphinx
diff --git a/tox.ini b/tox.ini
@@ -1,5 +1,5 @@
 [tox]
-envlist = py{27,34,35,36}-sphinx{13,14,15}
+envlist = py{27,34,35,36}-sphinx{13,14,15,16}, docs
 
 [tox:travis]
 2.7 = py27-sphinx{13,14,15}
@@ -17,5 +17,13 @@ deps =
     sphinx13: Sphinx < 1.4
     sphinx14: Sphinx < 1.5
     sphinx15: Sphinx < 1.6
+    sphinx16: Sphinx < 1.7
 commands =
     py.test {posargs}
+
+[testenv:docs]
+changedir = {toxinidir}/docs
+deps =
+    -r{toxinidir}/docs/requirements.txt
+commands =
+    sphinx-build -b html -d {envtmpdir}/doctrees .  {envtmpdir}/html