Skip to content

Commit

Permalink
Show inherited members in documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
jfjlaros committed Feb 20, 2021
1 parent 1d6252f commit de3253c
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 7 deletions.
10 changes: 9 additions & 1 deletion docs/api/crossmap.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
Crossmapper
===========

.. automodule:: mutalyzer_crossmapper.crossmapper
.. autoclass:: mutalyzer_crossmapper.crossmapper.Genomic
:members:

.. autoclass:: mutalyzer_crossmapper.crossmapper.NonCoding
:inherited-members:
:members:

.. autoclass:: mutalyzer_crossmapper.crossmapper.Coding
:inherited-members:
:members:
12 changes: 6 additions & 6 deletions docs/library.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ used to convert to and from genomic positions.
>>> crossmap.genomic_to_coordinate(1)
0
See :doc:`api/crossmap` for a detailed description.
See section :doc:`api/crossmap` for a detailed description.

The ``NonCoding`` class
-----------------------
Expand Down Expand Up @@ -96,7 +96,7 @@ parameter should be set to ``True``. In our example, HGVS position "g.36"
>>> crossmap.noncoding_to_coordinate((9, -1))
35
See :doc:`api/crossmap` for a detailed description.
See section :doc:`api/crossmap` for a detailed description.

The ``Coding`` class
--------------------
Expand Down Expand Up @@ -240,7 +240,7 @@ table, we show a number of annotated examples.
- Downstream position.
- invalid

See :doc:`api/crossmap` for a detailed description.
See section :doc:`api/crossmap` for a detailed description.

Locations
---------
Expand All @@ -267,7 +267,7 @@ behaviour can be altered by setting the optional argument ``p`` to ``1``.
>>> nearest_location(exons, 37, 1)
3
See :doc:`api/location` for a detailed description.
See section :doc:`api/location` for a detailed description.

Basic classes
-------------
Expand Down Expand Up @@ -299,7 +299,7 @@ for the semantics.
For loci that reside on the reverse complement strand, the optional
``inverted`` constructor parameter should be set to ``True``.

See :doc:`api/locus` for a detailed description.
See section :doc:`api/locus` for a detailed description.

The ``MultiLocus`` class
^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -321,4 +321,4 @@ The interface to this class is similar to that of the ``Locus`` class.
>>> multilocus.to_position(38)
(11, -2)
See :doc:`api/multi_locus` for a detailed description.
See section :doc:`api/multi_locus` for a detailed description.

0 comments on commit de3253c

Please sign in to comment.