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

Fix broken links [#1569] #1570

Merged
merged 5 commits into from
Aug 16, 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: 15 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -148,3 +148,18 @@ def prose_list(items):
'pandas': ('https://pandas.pydata.org/docs', None),
'treetime': ('https://treetime.readthedocs.io/en/stable/', None),
}

# -- Linkchecking ------------------------------------------------------------

## NOTE: for both sets of regular expressions that follow, the
## underlying linkchecker code uses `re.match()` to apply them to URLs
## — so there's already an implicit "only at the beginning of a
## string" matching happening, and something like a plain `r'google'`
## regular expression will _NOT_ match all google.com URLs.
linkcheck_ignore = []
linkcheck_anchors_ignore_for_url = [
# Github uses anchor-looking links for highlighting lines but
# handles the actual resolution with Javascript, so skip anchor
# checks for Github URLs:
r'^https://github\.com',
]
3 changes: 1 addition & 2 deletions docs/faq/metadata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,7 @@ locations ('new_zealand' became 'New Zealand').

Auspice will still do this if you are exporting 'V1' type JSON files
(from augur v5 or augur v6 using ``export v1``), but will not do this if
you are using ``export v2`` (`read
more <../releases/migrating-v5-v6.html#prettifying-metadata-fields>`__).
you are using ``export v2`` (:ref:`read more <prettifying-metadata-fields>`).
Instead, you should update your metadata files so that traits look the
same as you'd like them to display in Auspice (change 'new_zealand' to
'New Zealand' in your metadata, and in any additional latitude-longitude
Expand Down
4 changes: 2 additions & 2 deletions docs/faq/what-is-a-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ These steps, taken together, are what we refer to as a "build".

### Example build

The [Zika virus tutorial](https://docs.nextstrain.org/en/latest/tutorials/zika.html#build-steps) describes a build which contains the following steps:
The [Zika virus tutorial](https://docs.nextstrain.org/en/latest/tutorials/creating-a-phylogenetic-workflow.html#run-a-nextstrain-build) describes a build which contains the following steps:

1. Prepare pathogen sequences and metadata
2. Align sequences
Expand All @@ -28,5 +28,5 @@ If you look at the [other tutorials](https://docs.nextstrain.org/en/latest/tutor
While it is possible to run a build by running each of the individual steps, we typically group these together into a make-type file.
[Snakemake](https://snakemake.readthedocs.io/en/stable/index.html) is "a tool to create reproducible and scalable data analyses... via a human-readable, Python-based language."

> Snakemake is installed as part of the [conda environment](https://docs.nextstrain.org/en/latest/guides/install/local-installation.html#install-augur-auspice-with-conda) or the [docker container](https://docs.nextstrain.org/en/latest/guides/install/cli-install.html).
> Snakemake is installed as part of the [conda environment](https://docs.nextstrain.org/en/latest/guides/install/local-installation.html) or the [docker container](https://docs.nextstrain.org/en/latest/guides/install/cli-install.html).
genehack marked this conversation as resolved.
Show resolved Hide resolved
If you ever see a build which has a "Snakefile" then you can run this by typing `snakemake --cores 1` or `nextstrain build --cpus 1 .`, respectively.
2 changes: 1 addition & 1 deletion docs/installation/non-python-dependencies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Augur uses some external bioinformatics programs that are not available on PyPI:
- ``augur tree`` requires at least one of:

- `IQ-TREE <http://www.iqtree.org/>`__ (used by default)
- `RAxML <https://sco.h-its.org/exelixis/web/software/raxml/>`__ (optional alternative)
- `RAxML <https://cme.h-its.org/exelixis/web/software/raxml/>`__ (optional alternative)
- `FastTree <http://www.microbesonline.org/fasttree/>`__ (optional alternative)

- Bacterial data (or any VCF usage) requires `vcftools <https://vcftools.github.io/>`__
Expand Down
534 changes: 0 additions & 534 deletions docs/releases/migrating-v5-v6.md

This file was deleted.

Loading
Loading