Merge pull request #2 from hauten/doc-setup

configuration changes for doc setup
hauten · Sep 17, 2019 · 13489cc · 13489cc
2 parents 9bb14c8 + 73e583f
commit 13489cc
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+# Sphinx documentation
+/_build/
diff --git a/README.md b/README.md
@@ -1,2 +1,5 @@
 # SecondAttempt
-Second sandbox for testing Sphinx &amp; RtD
+
+[![Documentation Status](https://readthedocs.org/projects/secondattempt/badge/?version=latest)](https://secondattempt.readthedocs.io/en/latest/?badge=latest)
+
+Check out the [documentation](https://secondattempt.readthedocs.io/en/latest/)!
diff --git a/docs/conf.py b/docs/conf.py
@@ -41,13 +41,16 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
+# Tells Sphinx the name of the master .rst file.
+master_doc = 'index'
+
 
 # -- 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'
+html_theme = 'sphinx_rtd_theme'
 
 # 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,