Update the docs

mdmintz · mdmintz · commit 80652544eb0d · 2020-08-24T15:55:24.000-04:00
diff --git a/README.md b/README.md
@@ -122,7 +122,8 @@ class MyTestClass(BaseCase):
 
     def test_basic(self):
         self.open("https://store.xkcd.com/search")
-        self.type('input[name="q"]', "xkcd book\n")
+        self.type('input[name="q"]', "xkcd book")
+        self.click('input[value="Search"]')
         self.assert_text("xkcd: volume 0", "h3")
         self.open("https://xkcd.com/353/")
         self.assert_title("xkcd: Python")
@@ -132,6 +133,8 @@ class MyTestClass(BaseCase):
         self.go_back()
         self.click_link_text("About")
         self.assert_exact_text("xkcd.com", "h2")
+        self.click_link_text("geohashing")
+        self.assert_element("#comic img")
 ```
 
 * By default, **[CSS Selectors](https://www.w3schools.com/cssref/css_selectors.asp)** are used for finding page elements.
@@ -470,7 +473,7 @@ pytest proxy_test.py --proxy=proxy1
 
 <h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> Changing the User-Agent:</h3>
 
-If you wish to change the User-Agent for your browser tests (Chrome and Firefox only), you can add ``--agent="USER AGENT STRING"`` as an argument on the command-line.
+If you wish to change the User-Agent for your browser tests (Chromium and Firefox only), you can add ``--agent="USER AGENT STRING"`` as an argument on the command-line.
 
 ```bash
 pytest user_agent_test.py --agent="Mozilla/5.0 (Nintendo 3DS; U; ; en) Version/1.7412.EU"
@@ -805,6 +808,8 @@ Additionally, you can use the ``@retry_on_exception()`` decorator to specificall
 <div><b>If you like us, give us a star!</b></div>
 <div><a href="https://github.com/seleniumbase/SeleniumBase/stargazers"><img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg?color=888CFA" title="Stargazers" /></a></div>
 </p>
+<div><!--not_for_site--><iframe src="https://seleniumbase.io/" style="width:92%;height:450px;" title="iframe content"></iframe></div>
+<div><!--not_for_site--><iframe src="https://seleniumbase.io/help_docs/ReadMe/" style="width:92%;height:580px;" title="iframe content"></iframe></div>
 <p><div><a href="https://github.com/mdmintz">https://github.com/mdmintz</a></div></p>
 
 <div><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_sb.png" title="SeleniumBase" width="290" /></a></div>
diff --git a/docs/prepare.py b/docs/prepare.py
@@ -115,6 +115,9 @@ def main(*args, **kwargs):
                 'title="SeleniumBase" width="20" /> SeleniumBase Docs '
                 '<img src="https://seleniumbase.io/img/sb_icon.png" '
                 'title="SeleniumBase" width="20" /></h2>')
+        if "<!--not_for_site--><iframe" in line and "</iframe>" in line:
+            changed = True
+            line = ("")
         seleniumbase_lines.append(line)
     if changed:
         out_file = codecs.open(readme_file, "w+", encoding='utf-8')
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,7 +1,7 @@
 livereload==2.6.3;python_version>="3.6"
 pymdown-extensions==8.0
 mkdocs==1.1.2
-mkdocs-material==5.5.7
+mkdocs-material==5.5.8
 mkdocs-simple-hooks==0.1.1
 mkdocs-material-extensions==1.0
 mkdocs-minify-plugin==0.3.0
diff --git a/examples/chart_maker/ReadMe.md b/examples/chart_maker/ReadMe.md
@@ -1,6 +1,6 @@
 <h3 align="left"><img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_sb23.png" alt="SeleniumBase" width="290" /></h3>
 
-# 📊 Chart Maker 📊
+<h3> 📊 Chart Maker 📊 </h3>
 
 SeleniumBase Chart Maker allows you to create HTML charts with Python. (Using HighCharts JS)
 
@@ -53,7 +53,7 @@ Here are screenshots from the examples:
 <a href="https://seleniumbase.io/other/multi_series_chart.png"><img width="500" src="https://seleniumbase.io/other/multi_series_chart.png" title="Screenshot"></a><br>
 
 
-### Here's a line chart example:
+<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Here's a line chart example:</h3>
 
 ```python
 from seleniumbase import BaseCase
@@ -74,7 +74,7 @@ class MyChartMakerClass(BaseCase):
         self.begin_presentation(filename="line_chart.html", interval=8)
 ```
 
-#### This example is from [test_line_chart.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/chart_maker/test_line_chart.py), which you can run from the ``examples/chart_maker`` folder with the following command:
+This example is from [test_line_chart.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/chart_maker/test_line_chart.py), which you can run from the ``examples/chart_maker`` folder with the following command:
 
 ```bash
 pytest test_line_chart.py
@@ -83,7 +83,7 @@ pytest test_line_chart.py
 Because that presentation above has an ``interval`` set to ``8``, it will automatically advance to the next slide after 8 seconds. (Or exit if there are no more slides.)
 
 
-### For a more advanced example (multiple charts in a presentation):
+<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> For a more advanced example (multiple charts in a presentation):</h3>
 
 ```python
 from seleniumbase import BaseCase
@@ -138,7 +138,7 @@ pytest chart_presentation.py
 Multi-Series charts can also be created. Try the available examples to learn more.
 
 
-## Chart Maker API
+<h2><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Chart Maker API</h2>
 
 ```python
 self.create_pie_chart(
@@ -245,7 +245,7 @@ self.create_area_chart(
 If creating multiple charts at the same time, you can pass the ``chart_name`` parameter to distinguish between different charts.
 
 
-### Adding a data point to a chart:
+<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Adding a data point to a chart:</h3>
 
 ```python
 self.add_data_point(label, value, color=None, chart_name=None):
@@ -262,7 +262,7 @@ self.add_data_point(label, value, color=None, chart_name=None):
 ```
 
 
-### Adding a new data series to an existing chart:
+<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Adding a new data series to an existing chart:</h3>
 
 ```python
 self.add_series_to_chart(self, data_name=None, chart_name=None):
@@ -276,7 +276,7 @@ self.add_series_to_chart(self, data_name=None, chart_name=None):
 ```
 
 
-### Saving a chart to a file:
+<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Saving a chart to a file:</h3>
 
 ```python
 self.save_chart(chart_name=None, filename=None):
@@ -292,7 +292,7 @@ self.save_chart(chart_name=None, filename=None):
 The full HTML of the chart is saved to the ``saved_charts/`` folder.
 
 
-### Extracting the HTML of a chart:
+<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Extracting the HTML of a chart:</h3>
 
 ```python
 self.extract_chart(chart_name=None):
@@ -304,7 +304,7 @@ self.extract_chart(chart_name=None):
 ```
 
 
-### Displaying a chart in the browser window:
+<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Displaying a chart in the browser window:</h3>
 
 ```python
 self.display_chart(chart_name=None, filename=None):
diff --git a/examples/presenter/ReadMe.md b/examples/presenter/ReadMe.md
@@ -1,26 +1,44 @@
 <h3 align="left"><img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_sb23.png" alt="SeleniumBase" width="290" /></h3>
 
-# 📰 Presenter 📰
+<h1> 📰 Presenter 📰 </h1>
 
-SeleniumBase Presenter allows you to create HTML presentations with Python.<br />
-The Reveal-JS library is used for running the presentations.
+<b>SeleniumBase Presenter allows you to create HTML presentations with Python.</b><br />
+(The "Reveal-JS" library is used for running the presentations.)
 
 **Here's a sample presentation:**
 
 <a href="https://seleniumbase.io/other/presenter.html"><img width="500" src="https://seleniumbase.io/other/presenter.gif" title="Screenshot"></a><br>
 
 ([Click on the image/GIF for the actual presentation](https://seleniumbase.io/other/presenter.html))
 
+([Here's the code for that presentation](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/presenter/my_presentation.py))
+
 Slides can include HTML, code, images, and iframes.
 
 Here's how to run the example presentation:
-```
+
+```bash
 cd examples/presenter
 pytest my_presentation.py
 ```
 
+**Here's a presentation with a chart:**
+
+<a href="https://seleniumbase.io/other/core_presentation.html"><img width="428" src="https://seleniumbase.io/other/sb_core_areas.png" title="Screenshot"></a><br>
+
+([Click on the image/GIF for the actual presentation](https://seleniumbase.io/other/core_presentation.html))
+
+([Here's the code for that presentation](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/presenter/core_presentation.py))
+
+Here's how to run that example:
+
+```bash
+cd examples/presenter
+pytest core_presentation.py
+```
+
 
-### Creating a new presentation:
+<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Creating a new presentation:</h3>
 
 ```python
 self.create_presentation(name=None, theme="serif", transition="default")
@@ -43,7 +61,7 @@ Notes are disabled by default. You can enable notes by specifying:
 ``show_notes=True``
 
 
-### Adding a slide to a presentation:
+<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Adding a slide to a presentation:</h3>
 
 ```python
 self.add_slide(content=None, image=None, code=None, iframe=None,
@@ -67,7 +85,7 @@ self.add_slide(content=None, image=None, code=None, iframe=None,
 ```
 
 
-### Running a presentation:
+<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Running a presentation:</h3>
 
 ```python
 self.begin_presentation(
@@ -90,7 +108,7 @@ Before the presentation is run, the full HTML is saved to the ``saved_presentati
 
 All methods have the optional ``name`` argument, which is only needed if you're creating multiple presentations at once.
 
-### Here's an example of using SeleniumBase Presenter:
+<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Here's an example of using SeleniumBase Presenter:</h3>
 
 ```python
 from seleniumbase import BaseCase
@@ -209,13 +227,13 @@ class MyPresenterClass(BaseCase):
             filename="presenter.html", show_notes=True, interval=0)
 ```
 
-#### This example is from [my_presentation.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/presenter/my_presentation.py), which you can run from the ``examples/presenter`` folder with the following command:
+That example is from [my_presentation.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/presenter/my_presentation.py), which you can run from the ``examples/presenter`` folder with the following command:
 
 ```bash
 pytest my_presentation.py
 ```
 
-### Saving a presentation:
+<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Saving a presentation:</h3>
 
 If you want to save the presentation you created as an HTML file, use:
 
diff --git a/help_docs/chart_maker.md b/help_docs/chart_maker.md
@@ -1,6 +1,6 @@
 <h3 align="left"><img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_sb23.png" alt="SeleniumBase" width="290" /></h3>
 
-# 📊 Chart Maker 📊
+<h3> 📊 Chart Maker 📊 </h3>
 
 SeleniumBase Chart Maker allows you to create HTML charts with Python. (Using HighCharts JS)
 
@@ -53,7 +53,7 @@ Here are screenshots from the examples:
 <a href="https://seleniumbase.io/other/multi_series_chart.png"><img width="500" src="https://seleniumbase.io/other/multi_series_chart.png" title="Screenshot"></a><br>
 
 
-### Here's a line chart example:
+<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Here's a line chart example:</h3>
 
 ```python
 from seleniumbase import BaseCase
@@ -74,7 +74,7 @@ class MyChartMakerClass(BaseCase):
         self.begin_presentation(filename="line_chart.html", interval=8)
 ```
 
-#### This example is from [test_line_chart.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/chart_maker/test_line_chart.py), which you can run from the ``examples/chart_maker`` folder with the following command:
+This example is from [test_line_chart.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/chart_maker/test_line_chart.py), which you can run from the ``examples/chart_maker`` folder with the following command:
 
 ```bash
 pytest test_line_chart.py
@@ -83,7 +83,7 @@ pytest test_line_chart.py
 Because that presentation above has an ``interval`` set to ``8``, it will automatically advance to the next slide after 8 seconds. (Or exit if there are no more slides.)
 
 
-### For a more advanced example (multiple charts in a presentation):
+<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> For a more advanced example (multiple charts in a presentation):</h3>
 
 ```python
 from seleniumbase import BaseCase
@@ -138,7 +138,7 @@ pytest chart_presentation.py
 Multi-Series charts can also be created. Try the available examples to learn more.
 
 
-## Chart Maker API
+<h2><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Chart Maker API</h2>
 
 ```python
 self.create_pie_chart(
@@ -245,7 +245,7 @@ self.create_area_chart(
 If creating multiple charts at the same time, you can pass the ``chart_name`` parameter to distinguish between different charts.
 
 
-### Adding a data point to a chart:
+<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Adding a data point to a chart:</h3>
 
 ```python
 self.add_data_point(label, value, color=None, chart_name=None):
@@ -262,7 +262,7 @@ self.add_data_point(label, value, color=None, chart_name=None):
 ```
 
 
-### Adding a new data series to an existing chart:
+<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Adding a new data series to an existing chart:</h3>
 
 ```python
 self.add_series_to_chart(self, data_name=None, chart_name=None):
@@ -276,7 +276,7 @@ self.add_series_to_chart(self, data_name=None, chart_name=None):
 ```
 
 
-### Saving a chart to a file:
+<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Saving a chart to a file:</h3>
 
 ```python
 self.save_chart(chart_name=None, filename=None):
@@ -292,7 +292,7 @@ self.save_chart(chart_name=None, filename=None):
 The full HTML of the chart is saved to the ``saved_charts/`` folder.
 
 
-### Extracting the HTML of a chart:
+<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Extracting the HTML of a chart:</h3>
 
 ```python
 self.extract_chart(chart_name=None):
@@ -304,7 +304,7 @@ self.extract_chart(chart_name=None):
 ```
 
 
-### Displaying a chart in the browser window:
+<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="24" /> Displaying a chart in the browser window:</h3>
 
 ```python
 self.display_chart(chart_name=None, filename=None):
diff --git a/help_docs/how_it_works.md b/help_docs/how_it_works.md
@@ -3,7 +3,7 @@
 <a id="how_seleniumbase_works"></a>
 <h2><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> How it works:</h2>
 
-At the core, SeleniumBase works by extending [pytest](https://docs.pytest.org/en/latest/) as a direct plugin. SeleniumBase automatically spins up web browsers for tests, and then gives those tests access to the SeleniumBase libraries through the [BaseCase class](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures/base_case.py). Tests are also given access to [SeleniumBase command-line arguments](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/plugins/pytest_plugin.py) and [SeleniumBase methods](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md), which provide additional functionality.
+At the core, SeleniumBase works by extending [pytest](https://docs.pytest.org/en/latest/) as a direct plugin. SeleniumBase automatically spins up web browsers for tests, and then gives those tests access to the SeleniumBase libraries through the [BaseCase class](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures/base_case.py). Tests are also given access to [SeleniumBase command-line arguments](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md) and [SeleniumBase methods](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md), which provide additional functionality.
 
 (NOTE: pytest uses a feature called test discovery to automatically find and run Python methods that start with "``test_``" from the file that you specified on the command line.)
 
