Move documentation to readthedocs

.readthedocs.yaml

@@ -0,0 +1,28 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+    # You can also specify other tool versions:
+    # nodejs: "16"
+    # rust: "1.55"
+    # golang: "1.17"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+formats: all
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: docs/requirements.txt

README.md

@@ -8,7 +8,7 @@
 
 <div align="center">
     <a href="https://github.com/hyperdimensional-computing/torchhd">
-        <img width="380px"  alt="Torchhd logo" src="https://raw.githubusercontent.com/hyperdimensional-computing/torchhd/main/resources/torchhd-logo.svg" />
+        <img width="380px"  alt="Torchhd logo" src="https://raw.githubusercontent.com/hyperdimensional-computing/torchhd/main/docs/images/torchhd-logo.svg" />
     </a>
 </div>
 
@@ -33,7 +33,7 @@ conda install -c torchhd torchhd
 
 ## Documentation
 
-You can find documentation for Torchhd [on the website](https://hyperdimensional-computing.github.io/torchhd/).
+You can find documentation for Torchhd [on the website](https://torchhd.readthedocs.io).
 
 ## Examples
 

dev-requirements.txt

@@ -3,8 +3,6 @@ torchvision
 pandas
 requests
 numpy
-sphinx
-sphinx-rtd-theme
 flake8
 pytest
 black

docs/_static/css/custom.css

@@ -0,0 +1,54 @@
+a,
+a:hover,
+a:visited {
+    color: #ee4c2c;
+}
+
+a:hover {
+    text-decoration: underline;
+}
+
+.wy-menu-vertical header,
+.wy-menu-vertical p.caption {
+    color: #262626;
+}
+
+
+.wy-nav-side {
+    background: #f3f4f7;
+}
+
+.wy-menu-vertical a,
+.wy-menu-vertical a:active,
+.wy-menu-vertical a:hover {
+    color: #6c6c6d;
+}
+
+.wy-menu-vertical a:hover {
+    background-color: #e8e9ea;
+    cursor: pointer;
+}
+
+.wy-menu-vertical a:active {
+    background-color: #e8e9ea;
+}
+
+.wy-side-nav-search input[type=text] {
+    border-color: #c9c9c9;
+}
+
+.rst-content .viewcode-back,
+.rst-content .viewcode-link {
+    color: #4974D1;
+}
+
+html.writer-html4 .rst-content dl:not(.docutils)>dt,
+html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt {
+    background: #f3f4f7;
+    color: #6c6c6d;
+    border-top: none;
+    border-left: 3px solid #ee4c2c;
+    padding: 0.5rem;
+    padding-right: 100px;
+    word-wrap: break-word;
+}

docs/conf.py

@@ -52,15 +52,24 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-#
-import sphinx_rtd_theme
 
 html_theme = "sphinx_rtd_theme"
-html_theme_path = [
-    "_themes",
-]
+html_theme_path = ["_themes"]
+
+html_logo = "images/torchhd-logo.svg"
+
+html_theme_options = {
+    "logo_only": True,
+    "display_version": True,
+    "prev_next_buttons_location": "bottom",
+    "style_nav_header_background": "white",
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
+
+html_css_files = [
+    "css/custom.css",
+]

docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx
+sphinx-rtd-theme

torchhd/datasets/airfoil_self_noise.py

@@ -9,7 +9,7 @@
 
 
 class AirfoilSelfNoise(data.Dataset):
-    """NASA data set <https://archive.ics.uci.edu/ml/datasets/airfoil+self-noise>`_, obtained from a series of aerodynamic and acoustic tests of two and three-dimensional airfoil blade sections conducted in an anechoic wind tunnel.
+    """`NASA data set <https://archive.ics.uci.edu/ml/datasets/airfoil+self-noise>`_, obtained from a series of aerodynamic and acoustic tests of two and three-dimensional airfoil blade sections conducted in an anechoic wind tunnel.
 
 
     Args:

torchhd/datasets/ccpp.py

@@ -9,7 +9,7 @@
 
 
 class CyclePowerPlant(data.Dataset):
-    """Combined cycle power planet dataset <https://archive.ics.uci.edu/ml/datasets/combined+cycle+power+plant>`_,
+    """`Combined cycle power planet dataset <https://archive.ics.uci.edu/ml/datasets/combined+cycle+power+plant>`_,
         Features consist of hourly average ambient variables Temperature (T), Ambient Pressure (AP), Relative Humidity (RH) and Exhaust Vacuum (V) to predict the net hourly electrical energy output (EP) of the plant.
 
     Args: