Merge pull request #3 from earthai-tech/main

Update doc

.readthedocs.yml

@@ -12,8 +12,8 @@ build:
     python: "3.10"
 
 # Documentation formats (optional)
-formats:
-   - pdf
+# formats:
+#   - pdf
 
 # Python requirements for building docs
 python:
@@ -27,9 +27,9 @@ sphinx:
   configuration: doc/source/conf.py
 
 # Build options
-build:
+# build:
   # Enabling system packages for dependencies that may require additional libraries
-  apt_packages:
-    - pandoc
-    - dvipng
-    - graphviz  # If diagrams are needed
+ #  apt_packages:
+ #   - pandoc
+ #   - dvipng
+ #   - graphviz  # If diagrams are needed

README.md

@@ -91,5 +91,5 @@ HWM is licensed under the BSD-3-Clause license. See the [LICENSE](LICENSE) file
 
 ---
 
-For additional resources, visit the [User Guide](https://hwm.readthedocs.io/en/latest/user_guide.html) and explore our rich set of tools designed for dynamic system modeling and time-series analysis.
+For additional resources, visit the [User Guide](https://hwm.readthedocs.io/en/latest/user_guide.html) and explore our rich tools for dynamic system modeling and time-series analysis. A practical [example of network intrusion detection](https://github.com/earthai-tech/hwm/blob/main/examples/detailed_hwm_vs_lstm.ipynb) is the use of [KDD Cup 1999](https://kdd.ics.uci.edu/databases/kddcup99/kddcup99.html) dataset.
 

doc/requirements.txt

@@ -5,15 +5,11 @@ sphinx>=5.0.2
 # sphinx_rtd_theme>=1.1.0
 sphinx-autobuild>=2021.3.14
 sphinxcontrib-napoleon>=0.7
-sphinxcontrib-viewcode>=2.0
+# sphinxcontrib-viewcode
 # sphinx-book-theme>=0.1.0
 # sphinx-pdj-theme
 # sphinx_wagtail_theme
 
-# Sphinx extensions
-sphinx.ext.intersphinx
-sphinx.ext.todo
-
 # Project-specific requirements
 numpy<2.0
 scipy>=1.7.0