File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ # preseq documentation
2+
3+ This is the (new) documentation for preseq that uses
4+ [ mkdocs] ( https://mkdocs.readthedocs.io ) to generate readthedocs pages.
5+ The public web verison of this documentation is available at
6+ [ preseq.readthedocs.io] ( https://preseq.readthedocs.io ) , but for users
7+ who wish to see the documentation on a web browser offline, you can
8+ build the documentation locally as described below.
9+
10+ ### Dependencies
11+
12+ To build the documentation locally, install mkdocs
13+ ``` console
14+ pip install -U mkdocs
15+ ```
16+
17+ ### Local compilation
18+
19+ Build the HTML documentation by running
20+ ``` console
21+ mkdocs build
22+ ```
23+ which will create a ` site ` directory where markdown files are
24+ converted to HTML
25+
26+ Create a local host for the HTML documentation by running
27+ ``` console
28+ mkdocs serve
29+ ```
30+ This will create the documentation, usually at http://localhost:8000 .
Original file line number Diff line number Diff line change 1+ # preseq
2+
3+ Under construction... But the PDF documentation still applies and can
4+ be found [ here] ( https://github.com/smithlabcode/preseq ) .
Original file line number Diff line number Diff line change 1+ Installation
2+ ============
3+
4+ ## Installation via conda
5+
6+ If you know how to use conda then preseq is available among the
7+ bioconda recipes. You can install it as follows if you have a conda
8+ environment activated:
9+
10+ ``` console
11+ $ conda install -c bioconda preseq
12+ ```
13+
14+ The instructions for installing conda are
15+ [ here] ( https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html ) .
Original file line number Diff line number Diff line change 1+ site_name : preseq
2+ strict : true
3+
4+ theme : readthedocs
5+ nav :
6+ - Home : ' index.md'
7+ - ' Installation ' : ' quickstart.md'
8+ - ' preseq on GitHub' : https://github.com/smithlabcode/preseq
You can’t perform that action at this time.
0 commit comments