Added to the ReadTheDoc (#372)

Co-authored-by: AARAVETI THIRUMALESH <athiruma@athiruma.remote.csb>

.github/workflows/PR.yml

@@ -52,5 +52,6 @@ jobs:
         policy_output: ${{ secrets.POLICY_OUTPUT }}
         RUNNER_PATH: ${{ secrets.RUNNER_PATH }}
       run: |
-        PYTHONPATH=. python cloud_governance/main/main.py 1> /dev/null 2> $RUNNER_PATH/err.log
-        [ -s $RUNNER_PATH/err.log ] && echo "Error is raised"
+        PYTHONPATH=. python cloud_governance/main/main.py 1> /dev/null 2> /home/runner/err.log
+        cat /home/runner/err.log
+    #    [ -s $RUNNER_PATH/err.log ] && echo "Error E2E is raised"

README.md

@@ -33,7 +33,7 @@ First release: Support AWS only
 Reference:
 * The cloud-governance package is placed in [PyPi](https://pypi.org/project/cloud-governance/)
 * The cloud-governance container image is placed in [Quay.io](https://quay.io/repository/ebattat/cloud-governance)
-
+* The cloud-governance readthedocs link is [ReadTheDocs](https://cloud-governance.readthedocs.io/en/latest/)
 ![](images/cloud_governance3.png)
 
 _**Table of Contents**_

requirments.txt

@@ -7,4 +7,6 @@ c7n==0.9.14
 PyGitHub==1.55
 requests==2.27.1
 elasticsearch==7.10.0
-elasticsearch_dsl==7.4.0
+elasticsearch_dsl==7.4.0
+sphinx==4.0.2
+sphinx_rtd_theme==0.4.3

setup.py

@@ -48,6 +48,8 @@
         'PyGitHub==1.55',  # gitleaks
         'elasticsearch==7.10.0',  # depend on elasticsearch server
         "elasticsearch_dsl==7.4.0",
+        "sphinx==4.0.2",
+        "sphinx_rtd_theme==0.4.3",
     ],
 
     setup_requires=['pytest', 'pytest-runner', 'wheel', 'coverage'],