From 0cb769ed76e02c610f05b5a70a516489fdd2b6d1 Mon Sep 17 00:00:00 2001 From: mhostetter Date: Sun, 6 Aug 2023 10:53:41 -0400 Subject: [PATCH] Flatten API reference some --- docs/api.rst | 51 ++++++++++++++++++++++++--------------------------- 1 file changed, 24 insertions(+), 27 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 6c8aa00c1..b527c5e17 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,25 +1,22 @@ .. py:module:: galois -galois -====== - Arrays ------- +====== .. python-apigen-group:: arrays Galois fields -------------- +============= .. python-apigen-group:: galois-fields Primitive elements -.................. +------------------ .. python-apigen-group:: galois-fields-primitive-elements Polynomials ------------ +=========== .. python-apigen-group:: polys @@ -28,97 +25,97 @@ Polynomials The :ref:`number-theory` section contains many functions that operate on polynomials. 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: 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