Skip to content

Commit 74c4aa7

Browse files
committed
moved docs to mkdocs
1 parent c5dea22 commit 74c4aa7

File tree

1 file changed

+83
-0
lines changed

1 file changed

+83
-0
lines changed

mkdocs.yml

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
site_name: votuderep Documentation
2+
site_description: Dereplication and filtering of viral operational taxonomic units (vOTUs)
3+
site_author: Andrea Telatin
4+
repo_url: https://github.com/telatin/derep-votus
5+
repo_name: telatin/derep-votus
6+
7+
# Directory configuration
8+
docs_dir: docs_src
9+
site_dir: docs
10+
11+
theme:
12+
name: material
13+
palette:
14+
# Light mode
15+
- scheme: default
16+
primary: indigo
17+
accent: indigo
18+
toggle:
19+
icon: material/brightness-7
20+
name: Switch to dark mode
21+
# Dark mode
22+
- scheme: slate
23+
primary: indigo
24+
accent: indigo
25+
toggle:
26+
icon: material/brightness-4
27+
name: Switch to light mode
28+
features:
29+
- navigation.instant
30+
- navigation.tracking
31+
- navigation.tabs
32+
- navigation.sections
33+
- navigation.expand
34+
- navigation.top
35+
- search.suggest
36+
- search.highlight
37+
- content.code.copy
38+
39+
nav:
40+
- Home: index.md
41+
- Getting Started:
42+
- Installation: installation.md
43+
- Quick Start: quickstart.md
44+
- CLI Commands:
45+
- Overview: cli/index.md
46+
- derep: cli/derep.md
47+
- filter: cli/filter.md
48+
- getdbs: cli/getdbs.md
49+
- tabulate: cli/tabulate.md
50+
- trainingdata: cli/trainingdata.md
51+
- splitcoverm: cli/splitcoverm.md
52+
- API Reference: api.md
53+
54+
plugins:
55+
- search
56+
- mkdocstrings:
57+
handlers:
58+
python:
59+
paths: [src]
60+
options:
61+
docstring_style: google
62+
show_source: true
63+
64+
markdown_extensions:
65+
- admonition
66+
- codehilite
67+
- pymdownx.highlight:
68+
anchor_linenums: true
69+
- pymdownx.inlinehilite
70+
- pymdownx.snippets
71+
- pymdownx.superfences
72+
- pymdownx.tabbed:
73+
alternate_style: true
74+
- pymdownx.details
75+
- tables
76+
- toc:
77+
permalink: true
78+
79+
extra:
80+
version: 0.6.0
81+
social:
82+
- icon: fontawesome/brands/github
83+
link: https://github.com/telatin/derep-votus

0 commit comments

Comments
 (0)