fix: fix security scan

Author: DiogoRibeiro7

.readthedocs.yml renamed to .readthedocs.yaml

@@ -3,10 +3,12 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.11"
+    python: "3.10"
 
 python:
   install:
+    - method: pip
+      path: .
     - requirements: docs/requirements.txt
 
 sphinx:

docs/requirements.txt

@@ -1,2 +1 @@
-sphinx
-myst-parser
+sphinx>=7.0

docs/source/_static/.gitkeep

@@ -1,7 +1,7 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath(".."))
+sys.path.insert(0, os.path.abspath("../.."))
 
 project = "Min Ratio Cycle"
 author = "Diogo Ribeiro"
@@ -13,7 +13,12 @@
     "sphinx.ext.viewcode",
 ]
 
+# Mock optional dependencies that are not installed in the documentation
+# build environment.
+autodoc_mock_imports = ["matplotlib", "networkx", "numpy", "psutil"]
+
 templates_path = ["_templates"]
 exclude_patterns = []
 
 html_theme = "alabaster"
+html_static_path = ["_static"]

docs/source/_templates/.gitkeep

@@ -5,6 +5,7 @@ Welcome to Min Ratio Cycle's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+   installation
    algorithm
    usage
    user_guide

docs/algorithm.rst renamed to docs/source/algorithm.rst

@@ -0,0 +1,16 @@
+Installation
+============
+
+To install the package from source:
+
+.. code-block:: bash
+
+    git clone https://github.com/DiogoRibeiro7/min_ratio_cycle
+    cd min_ratio_cycle
+    poetry install
+
+Or install the latest release from PyPI:
+
+.. code-block:: bash
+
+    pip install min-ratio-cycle