Display type hints in API documentation

mhostetter · Mar 16, 2022 · 1aceed0 · 1aceed0
1 parent 5efd39c
commit 1aceed0
Show file tree

Hide file tree

Showing 25 changed files with 2,585 additions and 1,835 deletions.
diff --git a/docs/_templates/class.rst b/docs/_templates/class.rst
@@ -4,7 +4,61 @@
 
 .. autoclass:: {{ objname }}
 
- {% block methods %}
- .. automethod:: __init__
+ {%- if methods %}
+ {% set constructor_methods = ['__init__'] %}
+ {%- for item in methods if item[0].isupper() %}
+ {{- constructor_methods.append(item)|default("", True) }}
+ {%- endfor %}
+
+ {% set special_methods = [] %}
+ {%- for item in methods if item.startswith('__') %}
+ {{- special_methods.append(item)|default("", True) }}
+ {%- endfor %}
+
+ {% set regular_methods = [] %}
+ {%- for item in methods if (not item[0].isupper() and not item.startswith('__')) %}
+ {{- regular_methods.append(item)|default("", True) }}
+ {%- endfor %}
+ {% endif %}
 
+ {% block constructor_methods %}
+ {% if constructor_methods %}
+ .. rubric:: {{ _('Constructors') }}
+ .. autosummary::
+ {% for item in constructor_methods %}
+ {{ item }}
+ {%- endfor %}
+ {% endif %}
  {% endblock %}
+
+ {% block special_methods %}
+ {% if special_methods %}
+ .. rubric:: {{ _('Special Methods') }}
+ .. autosummary::
+ {% for item in special_methods|sort %}
+ {{ item }}
+ {%- endfor %}
+ {% endif %}
+ {% endblock %}
+
+ {% block regular_methods %}
+ {% if regular_methods %}
+ .. rubric:: {{ _('Methods') }}
+ .. autosummary::
+ {% for item in regular_methods %}
+ {{ item }}
+ {%- endfor %}
+ {% endif %}
+ {% endblock %}
+
+ {% block attributes %}
+ {% if attributes %}
+ .. rubric:: {{ _('Attributes') }}
+ .. autosummary::
+ {% for item in attributes %}
+ {{ item }}
+ {%- endfor %}
+ {% endif %}
+ {% endblock %}
+
+ .. automethod:: __init__
diff --git a/docs/api/fec.rst b/docs/api/fec.rst
@@ -8,7 +8,6 @@ This section contains classes and functions for constructing forward error corre
 FEC classes
 -----------
 
-.. rubric::
 .. autosummary::
  :template: class.rst
  :toctree:
@@ -19,7 +18,6 @@ FEC classes
 Linear block code functions
 ---------------------------
 
-.. rubric::
 .. autosummary::
  :toctree:
 
@@ -29,7 +27,6 @@ Linear block code functions
 Cyclic code functions
 ---------------------
 
-.. rubric::
 .. autosummary::
  :toctree:
 

diff --git a/docs/api/galois-fields.rst b/docs/api/galois-fields.rst
@@ -5,25 +5,31 @@ This section contains classes and functions for creating Galois field arrays.
 
 .. currentmodule:: galois
 
-Galois field class creation
----------------------------
+Galois field classes
+--------------------
+
+Class factory functions
+.......................
 
-.. rubric:: Class factory functions
 .. autosummary::
  :toctree:
 
  GF
  Field
 
-.. rubric:: Abstract base classes
+Abstract base classes
+.....................
+
 .. autosummary::
  :template: class.rst
  :toctree:
 
  FieldArray
  FieldClass
 
-.. rubric:: Pre-made Galois field classes
+Pre-made Galois field array classes
+...................................
+
 .. autosummary::
  :template: class_only_init.rst
  :toctree:
@@ -33,7 +39,9 @@ Galois field class creation
 Prime field functions
 ---------------------
 
-.. rubric:: Primitive roots
+Primitive roots
+...............
+
 .. autosummary::
  :toctree:
 
@@ -44,15 +52,19 @@ Prime field functions
 Extension field functions
 -------------------------
 
-.. rubric:: Irreducible polynomials
+Irreducible polynomials
+.......................
+
 .. autosummary::
  :toctree:
 
  irreducible_poly
  irreducible_polys
  is_irreducible
 
-.. rubric:: Primitive polynomials
+Primitive polynomials
+.....................
+
 .. autosummary::
  :toctree:
 
@@ -62,7 +74,9 @@ Extension field functions
  matlab_primitive_poly
  is_primitive
 
-.. rubric:: Primitive elements
+Primitive elements
+..................
+
 .. autosummary::
  :toctree:
 

diff --git a/docs/api/galois.rst b/docs/api/galois.rst
@@ -18,6 +18,7 @@ Classes
 -------
 
 .. autosummary::
+ :template: class.rst
  :toctree:
 
  BCH
@@ -101,3 +102,11 @@ Functions
  square_free_factorization
  totatives
  trial_division
+
+Types
+-----
+
+.. autosummary::
+ :toctree:
+
+ PolyLike
diff --git a/docs/api/integer-factorization.rst b/docs/api/integer-factorization.rst
@@ -8,7 +8,6 @@ This section contains functions for factoring integers and analyzing their prope
 Prime factorization
 -------------------
 
-.. rubric::
 .. autosummary::
  :toctree:
 
@@ -17,7 +16,6 @@ Prime factorization
 Composite factorization
 -----------------------
 
-.. rubric::
 .. autosummary::
  :toctree:
 
@@ -27,7 +25,6 @@ Composite factorization
 Specific factorization algorithms
 ---------------------------------
 
-.. rubric::
 .. autosummary::
  :toctree:
 
@@ -36,10 +33,9 @@ Specific factorization algorithms
  pollard_p1
  pollard_rho
 
-Integer tests
--------------
+Tests
+-----
 
-.. rubric::
 .. autosummary::
  :toctree:
 

diff --git a/docs/api/linear-sequences.rst b/docs/api/linear-sequences.rst
@@ -8,7 +8,6 @@ This section contains classes and functions for creating and analyzing linear se
 Linear-feedback shift registers
 -------------------------------
 
-.. rubric::
 .. autosummary::
  :template: class.rst
  :toctree:
@@ -18,7 +17,6 @@ Linear-feedback shift registers
 Sequence analysis functions
 ---------------------------
 
-.. rubric::
 .. autosummary::
  :toctree:
 

diff --git a/docs/api/number-theory.rst b/docs/api/number-theory.rst
@@ -8,7 +8,6 @@ This section contains functions for performing modular arithmetic and other numb
 Divisibility
 ------------
 
-.. rubric::
 .. autosummary::
  :toctree:
 
@@ -23,7 +22,6 @@ Divisibility
 Congruences
 -----------
 
-.. rubric::
 .. autosummary::
  :toctree:
 
@@ -41,7 +39,6 @@ Congruences
 Integer arithmetic
 ------------------
 
-.. rubric::
 .. autosummary::
  :toctree:
 

diff --git a/docs/api/polys.rst b/docs/api/polys.rst
@@ -8,23 +8,27 @@ This section contains classes and functions for creating polynomials over Galois
 Polynomial classes
 ------------------
 
-.. rubric::
 .. autosummary::
+ :template: class.rst
  :toctree:
 
  Poly
 
 Special polynomials
 -------------------
 
-.. rubric:: Irreducible polynomials
+Irreducible polynomials
+.......................
+
 .. autosummary::
  :toctree:
 
  irreducible_poly
  irreducible_polys
 
-.. rubric:: Primitive polynomials
+Primitive polynomials
+.....................
+
 .. autosummary::
  :toctree:
 
@@ -33,7 +37,9 @@ Special polynomials
  conway_poly
  matlab_primitive_poly
 
-.. rubric:: Interpolating polynomials
+Interpolating polynomials
+.........................
+
 .. autosummary::
  :toctree:
 
@@ -42,7 +48,9 @@ Special polynomials
 Polynomial functions
 --------------------
 
-.. rubric:: Divisibility
+Divisibility
+............
+
 .. autosummary::
  :toctree:
 
@@ -52,14 +60,18 @@ Polynomial functions
  prod
  are_coprime
 
-.. rubric:: Congruences
+Congruences
+...........
+
 .. autosummary::
  :toctree:
 
  pow
  crt
 
-.. rubric:: Polynomial factorization
+Factorization
+..............
+
 .. autosummary::
  :toctree:
 
@@ -68,7 +80,9 @@ Polynomial functions
  distinct_degree_factorization
  equal_degree_factorization
 
-.. rubric:: Polynomial tests
+Tests
+.....
+
 .. autosummary::
  :toctree:
 

diff --git a/docs/api/primes.rst b/docs/api/primes.rst
@@ -8,7 +8,6 @@ This section contains functions for generating primes and analyzing primality.
 Prime number generation
 -----------------------
 
-.. rubric::
 .. autosummary::
  :toctree:
 
@@ -23,7 +22,6 @@ Prime number generation
 Primality tests
 ---------------
 
-.. rubric::
 .. autosummary::
  :toctree:
 
@@ -38,7 +36,6 @@ Primality tests
 Specific primality tests
 ------------------------
 
-.. rubric::
 .. autosummary::
  :toctree:
 

diff --git a/docs/api/transforms.rst b/docs/api/transforms.rst
@@ -8,7 +8,6 @@ This section contains classes and functions for various transforms using Galois
 Number-theoretic transform
 --------------------------
 
-.. rubric::
 .. autosummary::
  :toctree: