That’s interesting, I will look at how SAGE folks manage this, thanks.
In fact, as of now, my primary concern is formatting examples in a "not"
ugly way. Furthermore, I am not at a stage where \example{}s are clickable
and executed in an Xterm like HyperDoc do, just api.spad does not seem to
handle them. I also do not know how HyperTex processes their commands, and
even more, when I wrote multiline examples I wrote several \example{}
lines. HyperDoc handles this, this why I do this that way. Maybe I can test
other ways.
By the way, improving how FriCAS handles ++ documentation is a must do for
me.
Greg
Le lun. 4 nov. 2024 à 19:03, 'Ralf Hemmecke' via FriCAS - computer algebra
system <[email protected]> a écrit :
> Hi Greg,
>
> On 11/4/24 18:30, Grégory Vanuxem wrote:
> > By the way, do you know if reStrucuredText handles examples?
> > \example{} in HyperTex? Or, maybe you know where I have to look?
> No, certainly not. You must understand, that the ++ docstrings basically
> have to be written in HyperTex (even for that I am not completely sure).
> Anyway how exactly they are translated for theyr appearance in HyperDoc,
> I have not taken the effort to look up (yet), but all of that is
> certainly in some source code in FriCAS. It is just that HyperTex is
> nowadays not a "common" format anymore as reStructuredText or MarkDown is.
>
> I guess, one would have to rewrite \examples{}, but I guess, we could
> learn from the Sage people and just "invent" a certain format that
> allows code in the ++ docstrings that would be executed when the
> generation of the api website happens. I think sphinx-doc allows quite
> some flexibility, but without agreeing on a particular format
> (reStructuredText or MarkDown) it makes no sense to look deeper into it.
>
> Ralf
>
> --
> You received this message because you are subscribed to the Google Groups
> "FriCAS - computer algebra system" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to [email protected].
> To view this discussion visit
> https://groups.google.com/d/msgid/fricas-devel/4cb8b36b-6dd2-49ae-affd-a432805eaada%40hemmecke.org
> .
>
--
You received this message because you are subscribed to the Google Groups
"FriCAS - computer algebra system" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion visit
https://groups.google.com/d/msgid/fricas-devel/CAHnU2dbu1y2XOqs9Xz4hCZUOfVv61YS25p%3DN%3DnGS6EzPXOFqqA%40mail.gmail.com.
