Skip to content

Commit

Permalink
Fix all docs warnings (#1693)
Browse files Browse the repository at this point in the history
* eliminate warning in getting_started.rst

* all warnings are errors

* use anonymous links instead of named links

* fix indentation of list item

* fix a variety of list item syntax issues

* remove illegal excess indentation

* several list item syntax fixes

* variety of list item fixes and a link fix

* remove extraneous character from string [] docs

* favicons must end in ico

* work around a bug in conda

Discussion of issue:

  spatialaudio/nbsphinx#24 (comment)

Root cause:

  ContinuumIO/anaconda-issues#1430

* fix link to tutorial

* fix broken links

* remove broken link to sample

* remove more broken links to sample

* remove references to sec-objects

* fix bad reference syntax

* two small fixes

1. Remove reference to sample
2. Move ico to correct directory

* remove unnecessary html_extra_path entry

* fix doctest skip syntax
  • Loading branch information
danking authored and tpoterba committed Apr 19, 2017
1 parent 9793cb3 commit a205789
Show file tree
Hide file tree
Showing 12 changed files with 146 additions and 123 deletions.
21 changes: 11 additions & 10 deletions python/hail/context.py
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ def grep(self, regex, path, max_count=100):
**Background**
:py:meth:`~hail.HailContext.grep` mimics the basic functionality of Unix ``grep`` in parallel, printing results to screen. This command is provided as a convenience to those in the statistical genetics community who often search enormous text files like VCFs. Find background on regular expressions at `RegExr <http://regexr.com/>`_.
:py:meth:`~hail.HailContext.grep` mimics the basic functionality of Unix ``grep`` in parallel, printing results to screen. This command is provided as a convenience to those in the statistical genetics community who often search enormous text files like VCFs. Find background on regular expressions at `RegExr <http://regexr.com/>`__.
:param str regex: The regular expression to match.
Expand All @@ -147,7 +147,7 @@ def import_bgen(self, path, tolerance=0.2, sample_file=None, npartitions=None):
**Notes**
Hail supports importing data in the BGEN file format. For more information on the BGEN file format,
see `here <http://www.well.ox.ac.uk/~gav/bgen_format/bgen_format_v1.1.html>`_. Note that only v1.1 BGEN files
see `here <http://www.well.ox.ac.uk/~gav/bgen_format/bgen_format_v1.1.html>`__. Note that only v1.1 BGEN files
are supported at this time.
Before importing, ensure that:
Expand Down Expand Up @@ -214,7 +214,7 @@ def import_gen(self, path, sample_file=None, tolerance=0.2, npartitions=None, ch
**Notes**
For more information on the .gen file format, see `here <http://www.stats.ox.ac.uk/%7Emarchini/software/gwas/file_format.html#mozTocId40300>`_.
For more information on the .gen file format, see `here <http://www.stats.ox.ac.uk/%7Emarchini/software/gwas/file_format.html#mozTocId40300>`__.
To ensure that the .gen file(s) and .sample file are correctly prepared for import:
Expand Down Expand Up @@ -404,7 +404,7 @@ def import_vcf(self, path, force=False, force_bgz=False, header_file=None, npart
**Notes**
Hail is designed to be maximally compatible with files in the `VCF v4.2 spec <https://samtools.github.io/hts-specs/VCFv4.2.pdf>`_.
Hail is designed to be maximally compatible with files in the `VCF v4.2 spec <https://samtools.github.io/hts-specs/VCFv4.2.pdf>`__.
:py:meth:`~hail.HailContext.import_vcf` takes a list of VCF files to load. All files must have the same header and the same set of samples in the same order
(e.g., a variant dataset split by chromosome). Files can be specified as :ref:`Hadoop glob patterns <sec-hadoop-glob>`.
Expand Down Expand Up @@ -477,10 +477,10 @@ def import_vcf(self, path, force=False, force_bgz=False, header_file=None, npart
- **va.filters** (*Set[String]*) -- Set containing all filters applied to a variant.
- **va.rsid** (*String*) -- rsID of the variant.
- **va.qual** (*Double*) -- Floating-point number in the QUAL field.
- **va.info** (*Struct*) -- All INFO fields defined in the VCF header can be found in the
struct ``va.info``. Data types match the type specified in the VCF header, and if
the declared ``Number`` is not 1, the result will be stored as an array.
- **va.info** (*Struct*) -- All INFO fields defined in the VCF header
can be found in the struct ``va.info``. Data types match the type
specified in the VCF header, and if the declared ``Number`` is not
1, the result will be stored as an array.
:param path: VCF file(s) to read.
:type path: str or list of str
Expand Down Expand Up @@ -515,6 +515,7 @@ def import_vcf(self, path, force=False, force_bgz=False, header_file=None, npart
:return: Variant dataset imported from VCF file(s)
:rtype: :py:class:`.VariantDataset`
"""

if generic:
Expand Down Expand Up @@ -587,7 +588,7 @@ def balding_nichols_model(self, populations, samples, variants, npartitions=None
linkage equilibrium. The relative sizes of the subpopulations are given by a probability vector :math:`\pi`; the ancestral allele frequencies are
drawn independently from a frequency spectrum :math:`P_0`; the subpopulations have diverged with possibly different :math:`F_{ST}` parameters :math:`F_k`
(here and below, lowercase indices run over a range bounded by the corresponding uppercase parameter, e.g. :math:`k = 1, \ldots, K`).
For each variant, the subpopulation allele frequencies are drawn a `beta distribution <https://en.wikipedia.org/wiki/Beta_distribution>`_, a useful continuous approximation of
For each variant, the subpopulation allele frequencies are drawn a `beta distribution <https://en.wikipedia.org/wiki/Beta_distribution>`__, a useful continuous approximation of
the effect of genetic drift. We denote the individual subpopulation memberships by :math:`k_n`, the ancestral allele frequences by :math:`p_{0, m}`,
the subpopulation allele frequencies by :math:`p_{k, m}`, and the genotypes by :math:`g_{n, m}`. The generative model in then given by:
Expand Down Expand Up @@ -745,4 +746,4 @@ def read_keytable(self, path):
@handle_py4j
def report(self):
"""Print information and warnings about VCF + GEN import and deduplication."""
self._jhc.report()
self._jhc.report()
Loading

0 comments on commit a205789

Please sign in to comment.