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 those files: look at src/doc/en/reference/curves/index.rst. The file src/doc/en/reference/combinat/index.rst, which is relevant to combinat/root_system/weyl_group, is a bit different — it includes a separate file which lists each file to be included.
With this in place, all of those files are automatically included when building the reference manual. -- John On Friday, February 14, 2025 at 7:55:48 AM UTC-8 aska...@gmail.com wrote: > 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# > > seems to be automatically generated from the code: > > https://github.com/sagemath/sage/blob/develop/src/sage/combinat/root_system/weyl_group.py > > I was wondering if there is an automated way to do this (e.g. if written > in the write format, to run some command or script that generates the > html/pdf). If so, if there is a guide somewhere that explains the format > conventions? > > Many thanks, > > Jesus > -- You received this message because you are subscribed to the Google Groups "sage-devel" group. To unsubscribe from this group and stop receiving emails from it, send an email to sage-devel+unsubscr...@googlegroups.com. To view this discussion visit https://groups.google.com/d/msgid/sage-devel/2c53f6a1-41a7-4985-9c65-fedec423d07dn%40googlegroups.com.
