Re: [sage-devel] Re: Is automatic documentation from doctests a thing?

2025-02-14 Thread Dima Pasechnik
To add a generic Python explainer: generation of documentation from docstrings and function/class signatures is normally done by a Python package sphinx, and Sage is not much of an exception to it (although it's accumulated a lot of outdated "improvements" to it, which we ought to streamline as

[sage-devel] Re: Is automatic documentation from doctests a thing?

2025-02-14 Thread John H Palmieri
The format is explained at https://doc.sagemath.org/html/en/developer/coding_basics.html#documentation-strings. Files in the Sage library are included in the documentation if they are cited in one of the files src/doc/en/reference/MODULE/index.rst. Many of those references are explicitly in th

[sage-devel] Is automatic documentation from doctests a thing?

2025-02-14 Thread aska...@gmail.com
Hi, We are working on a package on Geometric Invariant Theory and while writing up the documentation and seeing what other people did, I have noticed that the documentation for the Weyl Group library: https://doc.sagemath.org/html/en/reference/combinat/sage/combinat/root_system/weyl_group.html#