We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 7acd5cc commit c8af19bCopy full SHA for c8af19b
README.md
@@ -1,12 +1,19 @@
1
# 2025-sourmash-databases-doc-template
2
3
+This repo uses Jinja2 templating to automatically produce Markdown
4
+files describing the available sourmash databases. It also produces
5
+automated scripts that check that the relevant files are available for
6
+download.
7
+
8
+## Basic instructions
9
10
Run `make`. Then look at [outputs/md](outputs/md) to see output markdown.
11
12
## Previewing formatting with mkdocs
13
14
Run `mkdocs serve` to see the generated files.
15
-## Updating sourmash database list
16
+## Updating the database list in the sourmash docs
17
18
Copy all the files in `outputs/md/` into the sourmash repo under `doc/databases-md/`.
19
0 commit comments