Skip to content

Commit

Permalink
sagemathgh-39414: Fix documentation of integral_points
Browse files Browse the repository at this point in the history
    
Fixes sagemath#39395

Check https://doc-pr-39414--
sagemath.netlify.app/html/en/reference/discrete_geometry/ and
https://doc-pr-39414--sagemath.netlify.app/html/en/reference/discrete_ge
ometry/sage/geometry/integral_points_generic_dense to confirm the issue
is fixed.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [x] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#39414
Reported by: user202729
Reviewer(s):
  • Loading branch information
Release Manager committed Feb 3, 2025
2 parents 1fe4c1b + ea08771 commit 64291e0
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
6 changes: 5 additions & 1 deletion src/doc/en/reference/discrete_geometry/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
9 changes: 9 additions & 0 deletions src/sage/geometry/integral_points_generic_dense.pyx
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 64291e0

Please sign in to comment.