Merge pull request #3 from TomerFi/docs-enanchments

Docs enanchments

.circleci/config.yml

@@ -8,9 +8,6 @@ orbs:
   # Therefor the user and password environment variables does not need to be set.
   docker-publish: circleci/docker-publish@0.1.7
 
-
-
-
 #####################
 ##### Executors #####
 #####################
@@ -37,9 +34,6 @@ executors:
     environment:
       TZ: "Asia/Jerusalem"
 
-
-
-
 #####################
 ##### Commands ######
 #####################
@@ -70,7 +64,7 @@ commands:
           key: v1-switcher-webapi-machine-{{ .Branch }}-{{ checksum "Dockerfile" }}-{{ checksum ".dockerignore" }}
           paths:
             - docker-cache
-  
+
   # Node packages are installed here and then saved to cache.
   # Use with the node-docker executer as preparation before executing npm modules.
   prepare-node:
@@ -102,6 +96,7 @@ commands:
             . venv/bin/activate
             pip install -q --progress-bar off -r requirements.txt -c requirements_constraints.txt
             pip install -q --progress-bar off -r requirements_test.txt -c requirements_constraints.txt
+            pip install -q --progress-bar off -r requirements_docs.txt -c requirements_constraints.txt
       - save_cache:
           key: v1-switcher-webapi-python-{{ .Branch }}-{{ checksum "requirements.txt" }}-{{ checksum "requirements_test.txt" }}
           paths:
@@ -146,9 +141,6 @@ commands:
             . venv/bin/activate
             doc8 --config doc8.ini docs/source
 
-  # Note, currently the _static folder is empty and therefore it's being checked-out
-  # Becouse of the -W argument, sphinx convert the "can't find _static folder" warning to and show-stopper error.
-  # Therefore the _static folder is created before running sphinx-build.
   sphinx-build:
     description: Verify build docs with python sphinx by building into temp directory
     steps:
@@ -157,7 +149,6 @@ commands:
           command: |
             . venv/bin/activate
             mkdir sphinxtemp
-            mkdir docs/source/_static
             sphinx-build -W -b html -d sphinxtemp/doctrees docs/source sphinxtemp/html
             rm -r sphinxtemp
 
@@ -206,14 +197,10 @@ commands:
       - store_test_results:
           path: coverage_report
 
-
-
-
 #####################
 ####### Jobs ########
 #####################
 jobs:
-
   #############################################
   ### Jobs for the docs-lint-build workflow ###
   #############################################
@@ -320,9 +307,6 @@ jobs:
             codecov --file coverage_report/coverage.xml
             python-codacy-coverage -r coverage_report/coverage.xml
 
-
-
-
 #####################
 ##### Workslows #####
 #####################

.dockerignore

@@ -12,12 +12,14 @@ shellscripts
 .gitignore
 .prettierignore
 .prettierrc.yml
+.shellcheckrc
 bandit.yml
 doc8.ini
 Dockerfile
 Makefile
 mypy.ini
 pylintrc
+requirements_docs.txt
 requirements_test.txt
 tox.ini