Html tutorial review (#166)

* finished! the html_render tutorial

* a couple typos

* added more -- specifically generator comprehensions (#164)

* remove file

* Update README.rst

* Update README.rst

requirements also has ipython.. which wasn't installed on my system

* a little copy-editing

* Update html_renderer_tutorial.rst

* Update html_renderer_tutorial.rst

* Update html_renderer_tutorial.rst

* Update html_renderer_tutorial.rst

* Proof of tutorial

Did a light proof, focusing on spelling and obvious issues with grammar (lack of capitalization, periods for sentences), and formatting of code terms. I only removed -- when they were used in an obvious incorrect way, such as substituting for an opening comma, or for the beginning of a sentence.

* a bit of copy-editing

Author: UWEditor

README.rst

@@ -19,7 +19,7 @@ These documents are written in `Restructured Text <http://docutils.sourceforge.n
 
 To build the docs, you need Python, Sphinx, and sphinx-rtd-theme::
 
-  python3 -m pip install sphinx, sphinx-rtd-theme
+  pip3 install -r requirements.txt
 
 Should do it.
 

source/examples/html_render/run_html_render.py

@@ -190,8 +190,8 @@ def render_page(page, filename, indent=None):
 
 # render_page(page, "test_html_output7.html")
 
-# # Step 8
-# ########
+# # Step 8 and 9
+# ##############
 
 # page = hr.Html()
 

source/examples/html_render/test_html_render.py

@@ -184,6 +184,7 @@ def test_render_element():
 
 # #####################
 # # indentation testing
+# #  Uncomment for Step 9 -- adding indentation
 # #####################
 
 
@@ -192,11 +193,12 @@ def test_render_element():
 #     Tests that the indentation gets passed through to the renderer
 #     """
 #     html = Html("some content")
-#     file_contents = render_result(html, ind="   ")
+#     file_contents = render_result(html, ind="   ").rstrip()  #remove the end newline
 
 #     print(file_contents)
 #     lines = file_contents.split("\n")
 #     assert lines[0].startswith("   <")
+#     print(repr(lines[-1]))
 #     assert lines[-1].startswith("   <")
 
 
@@ -230,7 +232,7 @@ def test_render_element():
 
 #     assert lines[4].startswith(3 * Element.indent + "some")
 
-# this is for testing indenting -- we'll wait 'till we get to that
+
 # def test_element_indent1():
 #     """
 #     Tests whether the Element indents at least simple content

source/exercises/html_renderer.rst

@@ -377,6 +377,11 @@ where ``link`` is the link, and ``content`` is what you see. It can be called li
 
     A("http://google.com", "link to google")
 
+and it should render like::
+
+    <a href="http://google.com">link to google</a>
+
+
 You should be able to subclass from ``Element``, and only override the ``__init__`` --- calling the ``Element`` ``__init__`` from the  ``A`` ``__init__``
 
 You can now add a link to your web page.