Skip to content

Commit 99091fd

Browse files
author
Release Manager
committed
gh-39862: adding some pyx modules to the documentation inspired by #35468 only solve this partially. ``` from pathlib import Path p = Path("src/sage") data=list(p.rglob("*.pyx")) resu = [] for a in data: proc = subprocess.Popen(["git","grep",str(a.stem),"src/doc/en/refere nce"],stdout=PIPE, stderr=PIPE) x, y = proc.communicate() if not x: resu.append(a) ``` ### 📝 Checklist - [x] The title is concise and informative. - [x] I have linked a relevant issue or discussion. URL: #39862 Reported by: Frédéric Chapoton Reviewer(s): David Coudert
2 parents 227e321 + 8fa8cbc commit 99091fd

File tree

13 files changed

+31
-6
lines changed

13 files changed

+31
-6
lines changed

src/doc/en/reference/algebras/index.rst

+2
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,11 @@ Named associative algebras
4646
sage/algebras/askey_wilson
4747
sage/combinat/diagram_algebras
4848
sage/algebras/clifford_algebra
49+
sage/algebras/clifford_algebra_element
4950
sage/algebras/cluster_algebra
5051
sage/combinat/descent_algebra
5152
sage/algebras/down_up_algebra
53+
sage/algebras/exterior_algebra_groebner
5254
fusion_rings
5355
sage/algebras/hall_algebra
5456
sage/combinat/posets/incidence_algebras

src/doc/en/reference/categories/index.rst

+4
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ Individual Categories
5353
sage/categories/bialgebras
5454
sage/categories/bialgebras_with_basis
5555
sage/categories/bimodules
56+
sage/categories/chain_complexes
5657
sage/categories/classical_crystals
5758
sage/categories/coalgebras
5859
sage/categories/coalgebras_with_basis
@@ -70,6 +71,7 @@ Individual Categories
7071
sage/categories/coxeter_groups
7172
sage/categories/crystals
7273
sage/categories/cw_complexes
74+
sage/categories/dedekind_domains
7375
sage/categories/discrete_valuation
7476
sage/categories/distributive_magmas_and_additive_magmas
7577
sage/categories/division_rings
@@ -79,6 +81,7 @@ Individual Categories
7981
sage/categories/fields
8082
sage/categories/filtered_algebras
8183
sage/categories/filtered_algebras_with_basis
84+
sage/categories/filtered_hopf_algebras_with_basis
8285
sage/categories/filtered_modules
8386
sage/categories/filtered_modules_with_basis
8487
sage/categories/finite_complex_reflection_groups
@@ -160,6 +163,7 @@ Individual Categories
160163
sage/categories/modules_with_basis
161164
sage/categories/monoid_algebras
162165
sage/categories/monoids
166+
sage/categories/noetherian_rings
163167
sage/categories/number_fields
164168
sage/categories/objects
165169
sage/categories/ore_modules

src/doc/en/reference/graphs/index.rst

+3
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,10 @@ Libraries of algorithms
7979
sage/graphs/centrality
8080
sage/graphs/asteroidal_triples
8181
sage/graphs/independent_sets
82+
sage/graphs/chrompoly
8283
sage/graphs/cographs
8384
sage/graphs/comparability
85+
sage/graphs/isoperimetric_inequalities
8486
sage/graphs/line_graph
8587
sage/graphs/spanning_tree
8688
sage/graphs/pq_trees
@@ -99,6 +101,7 @@ Libraries of algorithms
99101
sage/graphs/graph_decompositions/rankwidth
100102
sage/graphs/graph_decompositions/bandwidth
101103
sage/graphs/graph_decompositions/cutwidth
104+
sage/graphs/graph_decompositions/fast_digraph
102105
sage/graphs/graph_decompositions/graph_products
103106
sage/graphs/graph_decompositions/slice_decomposition
104107
sage/graphs/graph_decompositions/modular_decomposition

src/doc/en/reference/matroids/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ Internals
7474
sage/matroids/lean_matrix
7575
sage/matroids/matroids_plot_helpers
7676
sage/matroids/set_system
77+
sage/matroids/union_matroid
7778
sage/matroids/unpickling
7879

7980
.. include:: ../footer.txt

src/doc/en/reference/modfrm/index.rst

+2
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,8 @@ Miscellaneous Modules (to be sorted)
100100
sage/modular/quatalg/brandt
101101
sage/modular/cusps_nf
102102
sage/modular/hypergeometric_motive
103+
sage/modular/hypergeometric_misc
103104
sage/modular/multiple_zeta
105+
sage/modular/modform/l_series_gross_zagier_coeffs
104106

105107
.. include:: ../footer.txt

src/doc/en/reference/modules/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -135,5 +135,6 @@ Misc
135135
sage/modules/tensor_operations
136136
sage/modules/finite_submodule_iter
137137
sage/modules/misc
138+
sage/modules/numpy_util
138139

139140
.. include:: ../footer.txt

src/doc/en/reference/quat_algebras/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ Quaternion Algebras
66

77
sage/algebras/quatalg/quaternion_algebra
88
sage/algebras/quatalg/quaternion_algebra_element
9-
9+
sage/algebras/quatalg/quaternion_algebra_cython
1010

1111
.. include:: ../footer.txt

src/sage/algebras/exterior_algebra_groebner.pyx

+2
Original file line numberDiff line numberDiff line change
@@ -438,6 +438,8 @@ cdef class GroebnerStrategy:
438438
"""
439439
Convert the computed Gröbner basis to a reduced Gröbner basis.
440440
441+
EXAMPLES::
442+
441443
sage: E.<x,y,z> = ExteriorAlgebra(QQ)
442444
sage: I = E.ideal([x+y*z])
443445
sage: I.groebner_basis(reduced=False)

src/sage/graphs/graph_decompositions/fast_digraph.pyx

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ cdef class FastDigraph:
9090

9191
def print_adjacency_matrix(self):
9292
r"""
93-
Displays the adjacency matrix of ``self``.
93+
Display the adjacency matrix of ``self``.
9494
9595
EXAMPLES::
9696

src/sage/matroids/union_matroid.pyx

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
"""
2+
Union of matroids
3+
"""
14
from sage.matroids.matroid cimport Matroid
25

36
cdef class MatroidUnion(Matroid):

src/sage/modular/hypergeometric_misc.pyx

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
"""
2-
Some utility routines for the hypergeometric motives package that benefit
3-
significantly from Cythonization.
2+
Utility routines for hypergeometric motives
3+
4+
These are functions that benefit significantly from Cythonization.
45
"""
56
from cpython cimport array
67
from cysignals.signals cimport sig_check

src/sage/modular/modform/l_series_gross_zagier.py

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
"""
2+
Gross-Zagier L-series
3+
"""
14
from sage.rings.integer import Integer
25
from sage.structure.sage_object import SageObject
36
from sage.lfunctions.dokchitser import Dokchitser

src/sage/modular/modform/l_series_gross_zagier_coeffs.pyx

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
"""
2+
Utilities for Gross-Zagier L-series
3+
"""
14
from cysignals.memory cimport check_allocarray, check_calloc, sig_free
25
from cysignals.signals cimport sig_check, sig_on, sig_off
36

@@ -14,7 +17,7 @@ from libc.string cimport memcpy
1417

1518
cpdef to_series(L, var):
1619
"""
17-
Create a power series element out of a list ``L`` in the variable`` var``.
20+
Create a power series element out of a list ``L`` in the variable ``var``.
1821
1922
EXAMPLES::
2023
@@ -42,7 +45,7 @@ def bqf_theta_series(Q, long bound, var=None):
4245
4346
.. MATH::
4447
45-
\sum_{(x,y) \in \Z^2} q^{f(x,y)} = \sum_{n=-\infty}^{\infty} r(n)q^n
48+
\sum_{(x,y) \in \ZZ^2} q^{f(x,y)} = \sum_{n=-\infty}^{\infty} r(n)q^n
4649
4750
where `r(n)` give the number of way `n` is represented by `f`.
4851

0 commit comments

Comments
 (0)