DOC: set up for read the docs

metagentools · Aug 15, 2024 · 001cbe4 · 001cbe4
1 parent 96d00fd
commit 001cbe4
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 0 deletions.
diff --git a/docs/final_GraphBin_binning_result.png → .../images/final_GraphBin_binning_result.png b/docs/final_GraphBin_binning_result.png → .../images/final_GraphBin_binning_result.png
diff --git a/docs/initial_binning_result.png → docs/images/initial_binning_result.png b/docs/initial_binning_result.png → docs/images/initial_binning_result.png
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,3 @@
+# GraphBin-Tk: assembly graph-based metagenomic binning toolkit
+
+GraphBin-Tk combines assembly graph-based metagenomic bin-refinement and binning techniques [GraphBin](https://github.com/metagentools/GraphBin), [GraphBin2](https://github.com/metagentools/GraphBin2) and [MetaCoAG](https://github.com/metagentools/MetaCoAG) along with support functionality to visualise and evaluate results, into one comprehensive toolkit.
diff --git a/docs/requirements.txt b/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
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,16 @@
+site_name: GraphBin-Tk
+site_url: "https://github.com/Vini2/gbintk"
+site_author: "Vijini Mallawaarachchi"
+repo_url: "https://github.com/Vini2/gbintk"
+repo_name: 'GitHub'
+theme:
+    name: readthedocs
+    highlightjs: true
+    hljs_languages:
+        - yaml
+        - bash
+        - shell
+        - text
+nav:
+    - HOME:
+      - Introduction: index.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# GraphBin-Tk: assembly graph-based metagenomic binning toolkit

		GraphBin-Tk combines assembly graph-based metagenomic bin-refinement and binning techniques [GraphBin](https://github.com/metagentools/GraphBin), [GraphBin2](https://github.com/metagentools/GraphBin2) and [MetaCoAG](https://github.com/metagentools/MetaCoAG) along with support functionality to visualise and evaluate results, into one comprehensive toolkit.