Update README and set Sphinx master doc to index.rst

joowani · joowani · commit 57ff92c0b86b · 2021-02-19T00:34:14.000-08:00
diff --git a/README.md b/README.md
@@ -11,16 +11,16 @@ Are you studying binary trees for your next exam, assignment or technical interv
 
 **Binarytree** is a Python library which lets you generate, visualize, inspect and 
 manipulate binary trees. Skip the tedious work of setting up test data, and dive 
-straight into practising your algorithms! Heaps and BSTs (binary search trees) are 
+straight into practising your algorithms. Heaps and BSTs (binary search trees) are 
 also supported.
 
-![](gifs/demo.gif)
+![IPython Demo](gifs/demo.gif)
 
 **New in version 6.0.0**: You can now use binarytree with 
 [Graphviz](https://graphviz.org) and [Jupyter Notebooks](https://jupyter.org) 
 ([documentation](https://binarytree.readthedocs.io/en/main/graphviz.html)):
 
-![](gifs/jupyter.gif)
+![Jupyter Demo](gifs/jupyter.gif)
 
 ## Requirements
 
diff --git a/docs/conf.py b/docs/conf.py
@@ -9,3 +9,4 @@
 ]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 html_theme = "sphinx_rtd_theme"
+master_doc = "index"
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,11 +1,11 @@
 Binarytree
 ----------
 
-Welcome to the documentation for **binarytree**!
+Welcome to the documentation for **binarytree**.
 
 **Binarytree** is Python library which lets you generate, visualize, inspect and
 manipulate binary trees. Skip the tedious work of setting up test data, and dive
-straight into practising algorithms! Heaps and BSTs (binary search trees) are also
+straight into practising algorithms. Heaps and BSTs (binary search trees) are also
 supported.
 
 Requirements

Original file line number	Diff line number	Diff line change
`@@ -9,3 +9,4 @@`
`9`	`9`	`]`
`10`	`10`	`exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]`
`11`	`11`	`html_theme = "sphinx_rtd_theme"`
	`12`	`+master_doc = "index"`