From 64273f8a07225602ac6db8063f41050f43dfd51d Mon Sep 17 00:00:00 2001 From: Michael Mintz Date: Fri, 15 May 2020 13:15:37 -0400 Subject: [PATCH] Update the docs --- README.md | 2 +- docs/requirements.txt | 2 + docs/sitemap.xml | 177 +++++++++++++++++++++++++++ help_docs/how_it_works.md | 6 +- help_docs/install.md | 15 +-- help_docs/using_safari_driver.md | 2 +- help_docs/virtualenv_instructions.md | 6 +- mkdocs.yml | 90 ++++++++++---- seleniumbase/common/ReadMe.md | 2 +- 9 files changed, 263 insertions(+), 39 deletions(-) create mode 100644 docs/sitemap.xml diff --git a/README.md b/README.md index 9bb9d268..4eada146 100755 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ - +

SeleniumBase

diff --git a/docs/requirements.txt b/docs/requirements.txt index f1ee49dc..88f621dc 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,3 +2,5 @@ mkdocs==1.1.2 mkdocs-material==5.0.2 mkdocs-simple-hooks==0.1.0 mkdocs-material-extensions==1.0 +mkdocs-minify-plugin==0.3.0 +fontawesome_markdown==0.2.6 diff --git a/docs/sitemap.xml b/docs/sitemap.xml new file mode 100644 index 00000000..683f9aff --- /dev/null +++ b/docs/sitemap.xml @@ -0,0 +1,177 @@ + + + + + + + https://seleniumbase.io/ + 2020-05-15T07:02:39+00:00 + 1.00 + + + https://seleniumbase.io/. + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/help_docs/features_list/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/help_docs/customizing_test_runs/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/examples/ReadMe/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/help_docs/translations/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/examples/example_logs/ReadMe/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/help_docs/method_summary/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/help_docs/mobile_testing/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/seleniumbase/console_scripts/ReadMe/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/examples/tour_examples/ReadMe/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/help_docs/how_it_works/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/help_docs/install_python_pip_git/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/help_docs/virtualenv_instructions/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/help_docs/install/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/help_docs/webdriver_installation/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/help_docs/verify_webdriver/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/seleniumbase/utilities/selenium_ide/ReadMe/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/examples/master_qa/ReadMe/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/examples/visual_testing/ReadMe/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/integrations/github/workflows/ReadMe/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/help_docs/happy_customers/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/help_docs/mysql_installation/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/help_docs/using_safari_driver/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/help_docs/hidden_files_info/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/integrations/azure/jenkins/ReadMe/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/integrations/google_cloud/ReadMe/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/integrations/katalon/ReadMe/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/seleniumbase/common/ReadMe/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/seleniumbase/utilities/selenium_grid/ReadMe/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/integrations/docker/ReadMe/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/seleniumbase/masterqa/ReadMe/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + https://seleniumbase.io/help_docs/ReadMe/ + 2020-05-15T07:02:39+00:00 + 0.80 + + + + \ No newline at end of file diff --git a/help_docs/how_it_works.md b/help_docs/how_it_works.md index 6498d6ca..2740b95d 100755 --- a/help_docs/how_it_works.md +++ b/help_docs/how_it_works.md @@ -1,11 +1,11 @@ [](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md) -## **How it works:** +## **How it works:** -At the core, SeleniumBase works by extending [pytest](https://docs.pytest.org/en/latest/) and [nosetests](http://nose.readthedocs.io/en/latest/) as a direct plugin to each one. 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), 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/seleniumbase/plugins/pytest_plugin.py) and [SeleniumBase methods](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md), which provide additional functionality. -(NOTE: pytest and nosetests use 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.) +(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.) To use SeleniumBase calls you need the following: ```python diff --git a/help_docs/install.md b/help_docs/install.md index 7657f6d7..8772882d 100755 --- a/help_docs/install.md +++ b/help_docs/install.md @@ -1,20 +1,21 @@ [](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md) -## Installation +## Installation -If you're installing SeleniumBase from a cloned copy on your machine, use: -``` +If installing SeleniumBase from a Git clone, use: +```bash +git clone https://github.com/seleniumbase/SeleniumBase.git +cd SeleniumBase/ pip install -r requirements.txt - python setup.py install ``` -If you're installing SeleniumBase directly [from PyPI (the Python Package Index)](https://pypi.python.org/pypi/seleniumbase), use: +If installing SeleniumBase directly [from PyPI (the Python Package Index)](https://pypi.python.org/pypi/seleniumbase), use: ```bash pip install seleniumbase ``` -If you're installing SeleniumBase [from a GitHub branch](https://github.com/seleniumbase/SeleniumBase), use: +If installing SeleniumBase [from a GitHub branch](https://github.com/seleniumbase/SeleniumBase), use: ```bash pip install git+https://github.com/seleniumbase/SeleniumBase.git@master#egg=seleniumbase ``` @@ -23,4 +24,4 @@ Useful ``pip`` options include: * Add ``--upgrade`` OR ``-U`` to upgrade an installation. * Add ``--force-reinstall`` for a clean install. -(If you're not using a virtual environment, you may need to add ``--user`` to your ``pip`` command if you're getting errors during installation.) +(If you're not using a virtual environment, you may need to add ``--user`` to your ``pip`` command if you're seeing errors during installation.) diff --git a/help_docs/using_safari_driver.md b/help_docs/using_safari_driver.md index 493df4ef..92a7adf6 100755 --- a/help_docs/using_safari_driver.md +++ b/help_docs/using_safari_driver.md @@ -2,7 +2,7 @@ *(NOTE: Safari's WebDriver requires macOS 10.13 "High Sierra" or later.)* -You can find the official Apple documentation regarding "Testing with WebDriver in Safari" on the following page: https://developer.apple.com/documentation/webkit/testing_with_webdriver_in_safari +You can find the official Apple documentation regarding "Testing with WebDriver in Safari" on the following page: [https://developer.apple.com/documentation/webkit/testing_with_webdriver_in_safari](https://developer.apple.com/documentation/webkit/testing_with_webdriver_in_safari) Run ``safaridriver --enable`` once in a terminal to enable Safari's WebDriver. (If you’re upgrading from a previous macOS release, you may need to prefix the command with ``sudo``.) diff --git a/help_docs/virtualenv_instructions.md b/help_docs/virtualenv_instructions.md index fd77f62b..38741fae 100755 --- a/help_docs/virtualenv_instructions.md +++ b/help_docs/virtualenv_instructions.md @@ -1,6 +1,6 @@ -## Virtual Environment Tutorial +## Virtual Environment Tutorial -### **Step 1**: Install VirtualEnv and VirtualEnvWrapper: +### Step 1: Install VirtualEnv and VirtualEnvWrapper: ### macOS / Linux: @@ -23,7 +23,7 @@ If you add ``source `which virtualenvwrapper.sh` `` to your local bash file (``~ python -m pip install --upgrade virtualenvwrapper-win ``` -### **Step 2**: Create a virtual environment: +### Step 2: Create a virtual environment: ### macOS / Linux / Windows: diff --git a/mkdocs.yml b/mkdocs.yml index 5fd961a9..b3e63baf 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,51 +1,95 @@ +# Project information site_name: SeleniumBase +site_url: https://seleniumbase.io/ +site_author: Michael Mintz +site_description: >- + Create browser tests for web and mobile user interfaces. + Fully customizable automation that builds on top of Selenium. + Uses Python and pytest to run tests and execute commands. +# Repository information +repo_name: seleniumbase/SeleniumBase repo_url: https://github.com/seleniumbase/SeleniumBase/ edit_uri: "" site_dir: "site" docs_dir: "docs" +# Copyright +copyright: Copyright © 2016 - 2020 Michael Mintz / SeleniumBase +# Extensions markdown_extensions: - - codehilite - - toc: + - fontawesome_markdown + - markdown.extensions.admonition + - markdown.extensions.attr_list + - markdown.extensions.codehilite: + guess_lang: false + - markdown.extensions.def_list + - markdown.extensions.footnotes + - markdown.extensions.meta + - markdown.extensions.toc: permalink: true +# Configuration theme: name: material logo: https://seleniumbase.io/img/logo3a.png favicon: img/favicon.ico + language: en + features: + - tabs +# Plugins plugins: - search + - minify: + minify_html: true - mkdocs-simple-hooks: hooks: on_pre_build: docs.prepare:main +# Customization +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/seleniumbase/SeleniumBase + - icon: fontawesome/brands/gitter + link: https://gitter.im/seleniumbase/SeleniumBase + - icon: fontawesome/brands/twitter + link: https://twitter.com/seleniumbase + - icon: fontawesome/brands/facebook + link: https://www.facebook.com/SeleniumBase + - icon: fontawesome/brands/instagram + link: https://instagram.com/seleniumbase +# Page tree nav: - Home Page: README.md - Features: help_docs/features_list.md - CMD Options: help_docs/customizing_test_runs.md + - Python Setup: + - Install Python, pip, git: help_docs/install_python_pip_git.md + - Virtualenv Instructions: help_docs/virtualenv_instructions.md + - Installation: + - Install SeleniumBase: help_docs/install.md + - WebDriver Installation: help_docs/webdriver_installation.md + - Verifying WebDriver: help_docs/verify_webdriver.md + - How it Works: help_docs/how_it_works.md - Examples: examples/ReadMe.md - Translations: help_docs/translations.md - - Reports: examples/example_logs/ReadMe.md - API Reference: help_docs/method_summary.md - Mobile Testing: help_docs/mobile_testing.md - Console Scripts: seleniumbase/console_scripts/ReadMe.md - Site Tours: examples/tour_examples/ReadMe.md - - How it Works: help_docs/how_it_works.md - - Install Python, pip, git: help_docs/install_python_pip_git.md - - Virtualenv Instructions: help_docs/virtualenv_instructions.md - - Install SeleniumBase: help_docs/install.md - - WebDriver Installation: help_docs/webdriver_installation.md - - Verifying WebDriver: help_docs/verify_webdriver.md - - Recorder and Exporting: seleniumbase/utilities/selenium_ide/ReadMe.md - MasterQA: examples/master_qa/ReadMe.md - Visual Testing: examples/visual_testing/ReadMe.md - - GitHub CI: integrations/github/workflows/ReadMe.md - - Happy Customers: help_docs/happy_customers.md - - MySQL installation: help_docs/mysql_installation.md - - Safari Driver Tips: help_docs/using_safari_driver.md - - Hidden Files on macOS: help_docs/hidden_files_info.md - - Jenkins on Azure: integrations/azure/jenkins/ReadMe.md - - Jenkins on Google Cloud: integrations/google_cloud/ReadMe.md - - Katalon Integration: integrations/katalon/ReadMe.md - - Common Decorators: seleniumbase/common/ReadMe.md - - Selenium Grid: seleniumbase/utilities/selenium_grid/ReadMe.md - - Docker Help: integrations/docker/ReadMe.md - - Master QA: seleniumbase/masterqa/ReadMe.md - - Help Docs: help_docs/ReadMe.md + - Integrations: + - Logging and Reports: examples/example_logs/ReadMe.md + - GitHub CI: integrations/github/workflows/ReadMe.md + - Selenium Grid: seleniumbase/utilities/selenium_grid/ReadMe.md + - Katalon Integration: integrations/katalon/ReadMe.md + - MySQL Help: help_docs/mysql_installation.md + - Jenkins on Azure: integrations/azure/jenkins/ReadMe.md + - Jenkins on Google Cloud: integrations/google_cloud/ReadMe.md + - Docker Help: integrations/docker/ReadMe.md + - Recorder and Exporting: seleniumbase/utilities/selenium_ide/ReadMe.md + - Master QA: seleniumbase/masterqa/ReadMe.md + - Extra Help: + - Table of Contents: help_docs/ReadMe.md + - Decorators & Security: seleniumbase/common/ReadMe.md + - Using Safari Driver: help_docs/using_safari_driver.md + - macOS Hidden Files: help_docs/hidden_files_info.md + - Happy Customers: help_docs/happy_customers.md diff --git a/seleniumbase/common/ReadMe.md b/seleniumbase/common/ReadMe.md index 49c8ef48..23539502 100755 --- a/seleniumbase/common/ReadMe.md +++ b/seleniumbase/common/ReadMe.md @@ -1,4 +1,4 @@ -## Using methods from the "common" folder. +## Using [seleniumbase/common](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/common) methods. ### Part 1: Decorators - (from [decorators.py](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/common/decorators.py))