Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs updates for Nextclade v3 #180

Merged
merged 2 commits into from
Jan 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Leave the environment with:
conda deactivate

> See below for how to build the docs for each subproject

## Building the docs with Docker

Alternatively, you can perform the same steps inside a container.
Expand All @@ -63,7 +63,7 @@ The HTML files appear in `build/html/` as usual, and can be viewed in a browser.
docs.nextstrain.org (the live version of the docs) is built and configured via [the Read The Docs dashboard for this project](https://readthedocs.org/projects/nextstrain/).
It uses [our readthedocs.yml](https://github.com/nextstrain/docs.nextstrain.org/blob/master/readthedocs.yml) to get the right dependencies and configuration parameters to build the docs on the Read the Docs server; [more about Read The Docs configuration](https://docs.readthedocs.io/en/stable/config-file/v2.html).

You can adjust settings for the live version of the docs on [the Read The Docs dashboard for this project](https://readthedocs.org/dashboard/nextstrain/edit/).
You can adjust settings for the live version of the docs on [the Read The Docs dashboard for this project](https://readthedocs.org/dashboard/nextstrain/edit/).
This includes:

#### Configuring redirects
Expand Down Expand Up @@ -148,7 +148,7 @@ We currently maintain the following subprojects for this project:
- [Augur](https://docs.nextstrain.org/projects/augur/en/stable/index.html), sourced from https://github.com/nextstrain/augur/tree/master/docs
- [Auspice](https://docs.nextstrain.org/projects/auspice/en/stable/), sourced from https://github.com/nextstrain/auspice/tree/master/docs
- [Nextstrain CLI](https://docs.nextstrain.org/projects/cli/en/stable/), sourced from https://github.com/nextstrain/cli/tree/master/doc
- [Nextclade (includes Nextclade Web, Nextclade CLI, Nextalign CLI)](https://docs.nextstrain.org/projects/nextclade/en/stable/index.html), sourced from https://github.com/nextstrain/nextclade/tree/master/docs
- [Nextclade (includes Nextclade Web and Nextclade CLI)](https://docs.nextstrain.org/projects/nextclade/en/stable/index.html), sourced from https://github.com/nextstrain/nextclade/tree/master/docs
- [ncov (SARS-CoV-2 Workflow)](https://docs.nextstrain.org/projects/ncov/en/latest/index.html), sourced from https://github.com/nextstrain/ncov/tree/master/docs


Expand All @@ -158,10 +158,10 @@ To link to a file in a subproject (or any other Read The Docs project), use [int
======================================
Welcome to Nextstrain's documentation!
======================================

Projects
========

+* :doc:`augur:index`
```
You also need to add the project you are linking to to the [intersphinx configuration](https://docs.readthedocs.io/en/stable/guides/intersphinx.html#using-intersphinx) of your build.
Expand All @@ -181,7 +181,7 @@ For full details, see the respective how-to-build-docs sections:

- [Augur](https://github.com/nextstrain/augur/blob/master/docs/contribute/DEV_DOCS.md#building-documentation)
- [Auspice](https://github.com/nextstrain/auspice/blob/master/DEV_DOCS.md#contributing-to-documentation)
- [Nextclade (includes Nextclade Web, Nextclade CLI, Nextalign CLI)](https://github.com/nextstrain/nextclade/tree/master/docs#building-the-docs-locally)
- [Nextclade (includes Nextclade Web and Nextclade CLI)](https://github.com/nextstrain/nextclade/tree/master/docs#building-the-docs-locally)
- [ncov (SARS-CoV-2 Workflow)](https://github.com/nextstrain/ncov/tree/master/docs#building-the-docs)


Expand Down Expand Up @@ -244,7 +244,7 @@ If you come across a useful feature to solve a common problem in the docs implem
Adding the following line to the table of contents statement in the index / root page of this project, for example, will remove the table of contents section from that document and only render the table of contents in the navigation bar on the left like this:

```diff
.. toctree::
.. toctree::
:maxdepth: 2
:titlesonly:
+ :hidden:
Expand All @@ -271,4 +271,3 @@ The types of documents are:
- [How-to guides](https://documentation.divio.com/how-to-guides/) - problem- / goal- oriented
- [Reference guides](https://documentation.divio.com/reference/) - information-oriented
- [Explanation](https://documentation.divio.com/explanation/) (aka discussions) - understanding oriented

5 changes: 2 additions & 3 deletions src/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ team and other Nextstrain users provide assistance. For private inquiries,
Exploring SARS-CoV-2 evolution <https://docs.nextstrain.org/projects/ncov/page/index.html>
tutorials/creating-a-bacterial-pathogen-workflow
tutorials/narratives-how-to-write
Analyzing genomes with Nextclade <https://docs.nextstrain.org/projects/nextclade/page/user/nextclade-web.html>
Analyzing genomes with Nextclade <https://docs.nextstrain.org/projects/nextclade/page/user/nextclade-web/index.html>

.. toctree::
:maxdepth: 1
Expand All @@ -81,8 +81,7 @@ team and other Nextstrain users provide assistance. For private inquiries,
Augur <https://docs.nextstrain.org/projects/augur/>
Auspice <https://docs.nextstrain.org/projects/auspice/>
Nextstrain CLI <https://docs.nextstrain.org/projects/cli/>
Nextclade CLI <https://docs.nextstrain.org/projects/nextclade/page/user/nextclade-cli.html>
Nextalign CLI <https://docs.nextstrain.org/projects/nextclade/page/user/nextalign-cli.html>
Nextclade CLI <https://docs.nextstrain.org/projects/nextclade/page/user/nextclade-cli/index.html>
nextstrain.org <https://docs.nextstrain.org/projects/nextstrain-dot-org/>

.. toctree::
Expand Down
9 changes: 4 additions & 5 deletions src/learn/parts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -236,11 +236,10 @@ together all of the above to provide a consistent way to run pathogen workflows,
access Nextstrain tools like Augur and Auspice across computing environments
such as Docker, Conda, and AWS Batch, and publish datasets to nextstrain.org.

:doc:`Nextclade <nextclade:index>` is a web application and two command-line
programs (``nextclade`` and ``nextalign``) for performing viral genome
alignment, mutation calling, clade assignment, quality checks, and phylogenetic
placement. Nextclade can be used indepedently of other Nextstrain tools as
well as integrated into workflows.
:doc:`Nextclade <nextclade:index>` is a web application and a command-line
tool for performing viral genome alignment, mutation calling, clade assignment,
quality checks, and phylogenetic placement. Nextclade can be used independently
of other Nextstrain tools as well as integrated into workflows.

With this overview, you'll be better prepared to :doc:`install Nextstrain
</install>` and :doc:`run a workflow </tutorials/running-a-workflow>` or :doc:`contribute
Expand Down
2 changes: 1 addition & 1 deletion src/snippets/ambient-setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

conda install --override-channels --strict-channel-priority \
-c conda-forge -c bioconda --yes \
augur auspice nextalign nextclade \
augur auspice nextclade \
snakemake git epiweeks pangolin pangolearn \
ncbi-datasets-cli

Expand Down