Use Sphinx Immaterial's python-apigen for API Reference

mhostetter · Jul 13, 2022 · 5161f4e · 5161f4e
1 parent 84ca4e1
commit 5161f4e
Show file tree

Hide file tree

Showing 40 changed files with 857 additions and 1,168 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1 +1,2 @@
+api/
 build/
diff --git a/docs/_static/extra.css b/docs/_static/extra.css
@@ -35,3 +35,14 @@
 .sd-tab-content {
  box-shadow: 0 -0.05rem var(--md-default-fg-color--lightest), 0 0.05rem var(--md-default-fg-color--lightest);
 }
+
+/* Modify Sphinx Immaterial python-apigen entity summary coloring. */
+/* .md-typeset :is(dl.objdesc,dl.api-field)>dt .sig-name:not(.sig-name-nonprimary ){
+ color: var(--md-accent-fg-color);
+} */
+/* .md-typeset .sig-inline a.reference.sig-name, .md-typeset .sig-inline a.reference:not(.desctype)>.n, .md-typeset .sig-inline a.reference>.sig-name, .md-typeset :-webkit-any(dl.objdesc,dl.api-field)>dt a.reference.sig-name, .md-typeset :-webkit-any(dl.objdesc,dl.api-field)>dt a.reference:not(.desctype)>.n, .md-typeset :-webkit-any(dl.objdesc,dl.api-field)>dt a.reference>.sig-name {
+ color: var(--md-default-fg-color--light);
+}
+.md-typeset .sig-inline a.reference.sig-name, .md-typeset .sig-inline a.reference:not(.desctype)>.n, .md-typeset .sig-inline a.reference>.sig-name, .md-typeset :is(dl.objdesc,dl.api-field)>dt a.reference.sig-name, .md-typeset :is(dl.objdesc,dl.api-field)>dt a.reference:not(.desctype)>.n, .md-typeset :is(dl.objdesc,dl.api-field)>dt a.reference>.sig-name {
+ color: var(--md-default-fg-color--light);
+} */
diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,122 @@
+.. py:module:: galois
+
+galois
+======
+
+Arrays
+------
+
+This section contains an abstract array base class and useful type hints related to arrays.
+
+.. python-apigen-group:: arrays
+
+Galois fields
+-------------
+
+This section contains abstract classes, class factories, and useful functions for Galois fields.
+
+.. python-apigen-group:: galois-fields
+
+Primitive elements
+..................
+
+.. python-apigen-group:: galois-fields-primitive-elements
+
+Polynomials
+-----------
+
+.. python-apigen-group:: polys
+
+Irreducible polynomials
+.......................
+
+.. python-apigen-group:: polys-irreducible
+
+Primitive polynomials
+.....................
+
+.. python-apigen-group:: polys-primitive
+
+Interpolating polynomials
+.........................
+
+.. python-apigen-group:: polys-interpolating
+
+Forward error correction
+------------------------
+
+.. python-apigen-group:: fec
+
+Linear sequences
+----------------
+
+.. python-apigen-group:: linear-sequences
+
+Transforms
+----------
+
+.. python-apigen-group:: transforms
+
+Number theory
+-------------
+
+Divisibility
+............
+
+.. python-apigen-group:: number-theory-divisibility
+
+Congruences
+...........
+
+.. python-apigen-group:: number-theory-congruences
+
+Primitive roots
+...............
+
+.. python-apigen-group:: number-theory-primitive-roots
+
+Integer arithmetic
+..................
+
+.. python-apigen-group:: number-theory-integer
+
+Factorization
+-------------
+
+Prime factorization
+...................
+
+.. python-apigen-group:: factorization-prime
+
+Composite factorization
+.......................
+
+.. python-apigen-group:: factorization-composite
+
+Specific factorization algorithms
+.................................
+
+.. python-apigen-group:: factorization-specific
+
+Primes
+------
+
+Prime number generation
+.......................
+
+.. python-apigen-group:: primes-generation
+
+Primality tests
+...............
+
+.. python-apigen-group:: primes-tests
+
+Specific primality tests
+........................
+
+.. python-apigen-group:: primes-specific-tests
+
+Configuration
+-------------
+
+.. python-apigen-group:: config
diff --git a/docs/api/fec.rst b/docs/api/fec.rst
diff --git a/docs/api/galois-fields.rst b/docs/api/galois-fields.rst
diff --git a/docs/api/galois.Array.rst b/docs/api/galois.Array.rst
diff --git a/docs/api/galois.GF2.rst b/docs/api/galois.GF2.rst
diff --git a/docs/api/galois.rst b/docs/api/galois.rst