DOC: Setup read the docs to fix #9

.readthedocs.yaml

@@ -0,0 +1,20 @@
+# .readthedocs.yaml
+# Read the Docs configuration file for MkDocs projects
+# 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-22.04
+  tools:
+    python: "3.12"
+
+mkdocs:
+  configuration: mkdocs.yml
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+  - requirements: docs/requirements.txt

docs/index.md

@@ -0,0 +1,3 @@
+# Reneo
+
+[Reneo](https://en.wiktionary.org/wiki/reneo) means to *unravel* or *untangle* in Latin. Reneo is a software developed to unravel or untangle high-quality genomes from viral communities (including both prokaryotic and eukaryotic viruses) found within metagenomes using assembly graphs. Reneo identifies viral components in the metagenomic assembly using virus orthologous groups from [VOGDB](https://vogdb.org/), models as flow networks and solves a minimum flow decomposition (MFD) problem to resolve genomic paths. Reneo was motivated based on a bacteriophage recovery tool named [Phables](https://github.com/Vini2/phables), specifically to extend the capabilities of Phables to all viruses.

docs/requirements.txt

@@ -0,0 +1,18 @@
+jinja2==3.1.4
+mkdocs>=1.3.1
+babel>=2.9.0
+click>=7.0
+Jinja2>=2.10.2
+Markdown>=3.2.1,<3.4
+PyYAML>=5.2
+watchdog>=2.0.0
+mdx_gh_links>=0.2
+ghp-import>=1.0
+pyyaml_env_tag>=0.1
+mkdocs-redirects>=1.0.1
+importlib_metadata>=4.3
+packaging>=20.5
+mergedeep>=1.3.4
+pygments>=2.12
+pymdown-extensions
+mkdocs-material

mkdocs.yml

@@ -0,0 +1,16 @@
+site_name: Reneo
+site_url: "https://github.com/Vini2/reneo"
+site_author: "Vijini Mallawaarachchi"
+repo_url: "https://github.com/Vini2/reneo"
+repo_name: 'GitHub'
+theme:
+    name: readthedocs
+    highlightjs: true
+    hljs_languages:
+        - yaml
+        - bash
+        - shell
+        - text
+nav:
+    - Home:
+      - Introduction: index.md