docs: conf: Changed HTML theme to RTD

Co-authored-by: John Andersen <john.s.andersen@intel.com>
Signed-off-by: John Andersen <john.s.andersen@intel.com>

Author: 2 people

.travis.yml

@@ -36,7 +36,7 @@ before_install:
 - docker pull mariadb:10
 - mkdir -p /home/travis/.cache/
 - mkdir -p /home/travis/.local/bin/
-- pip install coverage codecov sphinx sphinxcontrib-asyncio black
+- pip install coverage codecov sphinx sphinxcontrib-asyncio black sphinx_rtd_theme
 - curl -sSL https://github.com/XAMPPRocky/tokei/releases/download/v9.1.1/tokei-v9.1.1-x86_64-unknown-linux-gnu.tar.gz | tar xvz -C "$HOME/.local/bin/"
 script:
 - ./.ci/run.sh

CHANGELOG.md

@@ -32,11 +32,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   with entrypoints.
 - HTTP API service to enable interacting with DFFML over HTTP. Currently
   includes APIs for configuring and using Sources.
-- MySQL protocol source to work with data from a MySQL protocol compatable db
-- Bandit module which checks for high confidence and high severity issues.
-- Download python package obtained from package json url and extract to a 
-  temporary directory and clean up after it's usage.
-- Run a single operation in a standalone fashion.
+- MySQL protocol source to work with data from a MySQL protocol compatible db
+- shouldi example got a bandit operation which tells users not to install if
+  there are more than 5 issues of high severity and confidence.
+- dev service got the ability to run a single operation in a standalone fashion.
 ### Changed
 - feature/codesec became it's own branch, binsec
 - BaseOrchestratorContext `run_operations` strict is default to true. With
@@ -61,8 +60,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Ran `black` on whole codebase, including all submodules
 - CI style check now checks whole codebase
 - Merged HACKING.md into CONTRIBUTING.md
-- shouldi/cli to run bandit and safety checks.
-- The way safety gets called.
+- shouldi example runs bandit now in addition to safety
+- The way safety gets called
+- Switched documentation to Read The Docs theme
 ### Fixed
 - Docs get version from dffml.version.VERSION.
 - FileSource zipfiles are wrapped with TextIOWrapper because CSVSource expects
@@ -78,7 +78,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - CSV source now has `entry_point` decoration
 - JSON source now has `entry_point` decoration
 - Strict flag in df.memory is now on by default
-- Dynamicly created scikit models get config args correctly
+- Dynamically created scikit models get config args correctly
 ### Removed
 - Repo objects are no longer classification specific. Their `classify`,
   `classified`, and `classification` methods were removed.

README.md

@@ -1,6 +1,6 @@
 # Data Flow Facilitator for Machine Learning (dffml)
 
-[![Build Status](https://travis-ci.org/intel/dffml.svg?branch=master)](https://travis-ci.org/intel/dffml) [![codecov](https://codecov.io/gh/intel/dffml/branch/master/graph/badge.svg)](https://codecov.io/gh/intel/dffml) [![CII](https://bestpractices.coreinfrastructure.org/projects/2594/badge)](https://bestpractices.coreinfrastructure.org/projects/2594) [![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.svg)](https://gitter.im/dffml/community) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
+[![Build Status](https://travis-ci.org/intel/dffml.svg?branch=master)](https://travis-ci.org/intel/dffml) [![codecov](https://codecov.io/gh/intel/dffml/branch/master/graph/badge.svg)](https://codecov.io/gh/intel/dffml) [![CII](https://bestpractices.coreinfrastructure.org/projects/2594/badge)](https://bestpractices.coreinfrastructure.org/projects/2594) [![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.svg)](https://gitter.im/dffml/community) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 ## Documentation
 

docs/conf.py

@@ -57,7 +57,7 @@
 # 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"
 
 html_theme_options = {
     "description": "The fastest path to machine learning integration",

docs/index.rst

@@ -1,6 +1,22 @@
 Welcome to DFFML!
 =================
 
+.. image:: https://travis-ci.org/intel/dffml.svg?branch=master
+    :target: https://travis-ci.org/intel/dffml
+    :alt: Build Status
+.. image:: https://codecov.io/gh/intel/dffml/branch/master/graph/badge.svg
+    :target: https://codecov.io/gh/intel/dffml
+    :alt: codecov
+.. image:: https://bestpractices.coreinfrastructure.org/projects/2594/badge
+    :target: https://bestpractices.coreinfrastructure.org/projects/2594
+    :alt: CII
+.. image:: https://badges.gitter.im/gitterHQ/gitter.svg
+    :target: https://gitter.im/dffml/community
+    :alt: Gitter chat
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+    :target: https://github.com/psf/black
+    :alt: Code style: black
+
 Data Flow Facilitator for Machine Learning (DFFML) provides APIs for dataset
 generation, storage, and model definition.
 

setup.py

@@ -49,6 +49,7 @@
             "sphinx",
             "sphinxcontrib-asyncio",
             "black",
+            "sphinx_rtd_theme",
         ],
     },
     entry_points={