From f3bac54ce9da8f02a4c3c4206ff35598aac60584 Mon Sep 17 00:00:00 2001 From: user202729 <25191436+user202729@users.noreply.github.com> Date: Fri, 31 Jan 2025 11:13:22 +0700 Subject: [PATCH 1/2] Try to fix documentation of integral_points --- src/doc/en/reference/discrete_geometry/index.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/doc/en/reference/discrete_geometry/index.rst b/src/doc/en/reference/discrete_geometry/index.rst index 9dde6700341..a16b5ce8bdd 100644 --- a/src/doc/en/reference/discrete_geometry/index.rst +++ b/src/doc/en/reference/discrete_geometry/index.rst @@ -157,7 +157,11 @@ Helper functions sage/geometry/fan_isomorphism sage/geometry/hasse_diagram - sage/geometry/integral_points + sage/geometry/integral_points_generic_dense sage/geometry/hyperplane_arrangement/check_freeness +.. + The integral_points_generic_dense entry above should be sage/geometry/integral_points + but Sphinx does not handle the Python file containing only import very well + .. include:: ../footer.txt From ea0877173f7cc832e4e74fc4cf19bd9a00fc77a6 Mon Sep 17 00:00:00 2001 From: user202729 <25191436+user202729@users.noreply.github.com> Date: Fri, 31 Jan 2025 12:56:25 +0700 Subject: [PATCH 2/2] Add a docstring for explanation --- src/sage/geometry/integral_points_generic_dense.pyx | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/sage/geometry/integral_points_generic_dense.pyx b/src/sage/geometry/integral_points_generic_dense.pyx index 4709aa04fec..1dca01266f6 100644 --- a/src/sage/geometry/integral_points_generic_dense.pyx +++ b/src/sage/geometry/integral_points_generic_dense.pyx @@ -1,4 +1,13 @@ # cython: wraparound=False, boundscheck=False +r""" +Cython helper methods to compute integral points in polyhedra + +Note that while the URL of this documentation page ends with +``integral_points_generic_dense``, this is merely to allow Sphinx to generate +the documentation automatically. Imports should be from +:mod:`sage.geometry.integral_points`, as can be seen in the examples below. +Furthermore, not all functions are exported to the public interface. +""" from sage.modules.vector_integer_dense cimport Vector_integer_dense as VectorClass from sage.matrix.matrix_dense cimport Matrix_dense as MatrixClass