Merge pull request #68 from Maitreyapatel/readthedocs

Readthedocs
Maitreyapatel · Apr 5, 2023 · ced36e7 · ced36e7
2 parents 0fe6099 + fe6dca7
commit ced36e7
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 3 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,6 @@
+version: 2
+
+build:
+  os: "ubuntu-20.04"
+  tools:
+    python: "3.8"
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 <img src="extras/logo-no-background.png" width="50%">
 
 <p align="center">
-  <a href="#">[documentation]</a>
+  <a href="https://reliability-checklist.readthedocs.io/en/readthedocs/">[documentation]</a>
   <br> <br>
 </p>
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -24,6 +24,6 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 # html_theme = 'alabaster'
-html_theme = "furo"
+html_theme = "sphinx_rtd_theme"
 
 html_static_path = ["_static"]
diff --git a/requirements.txt b/requirements.txt
@@ -16,6 +16,11 @@ git+https://github.com/pattern3/pattern.git
 git+https://github.com/PrithivirajDamodaran/Parrot_Paraphraser.git
 scikit_learn==1.2.1
 
+# --------sphinx----------- #
+sphinx
+sphinx_rtd_theme<=2.0.0
+furo
+
 # --------- hydra --------- #
 hydra-core==1.2.0
 hydra-colorlog==1.2.0

diff --git a/setup.py b/setup.py
@@ -18,7 +18,7 @@ def package_files(directory):
 
 setup(
     name="reliability-checklist",
-    version="0.0.3",
+    version="0.1.0",
     description="A suite of reliability tests on NLP models.",
     author="Maitreya Patel",
     author_email="patel.maitreya57@gmail.com",