(from GitHub issues)
Hello Ralf, and others,
Le dim. 3 nov. 2024 à 00:52, Ralf Hemmecke <notificati...@github.com> a
écrit :
> The ++ docstrings have absolutely nothing to do with the book.
> They are, however, massaged in order to give "reasonable" output when
> processed by sphinx-doc.
> I have the impression that the docstrings do not always use proper
> hypertex.
> Some day we should agree on a better format, for example, MarkDown or
> reStructuredText. That would be reasonably readable (better than HyperTex)
> and there are converters to translate that to other formats like html or
> pdf. As long as we can produce the HyperTex format from it to keep HyperDoc
> happy, that would be a tedious work but can be done gradually.
>
I completely agree. Something that pandoc[1] or others can handle, it's
just an example I am not a specialist. Furthermore we have your FriCAS Web
API generator (src/doc/api.spad) that could help a lot I think. By the way,
do you know if reStrucuredText handles examples? \example{} in HyperTex?
Or, maybe you know where I have to look?
Greg
[1] https://pandoc.org/
> —
> Reply to this email directly, view it on GitHub
> <https://github.com/fricas/fricas/issues/185#issuecomment-2453228771>, or
> unsubscribe
> <https://github.com/notifications/unsubscribe-auth/AKGLAMF3BBDMXRN6SGIOTEDZ6VQTFAVCNFSM6AAAAABQK7G6LCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDINJTGIZDQNZXGE>
> .
> You are receiving this because you authored the thread.Message ID:
> <fricas/fricas/issues/185/2453228...@github.com>
>
--
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 fricas-devel+unsubscr...@googlegroups.com.
To view this discussion visit
https://groups.google.com/d/msgid/fricas-devel/CAHnU2dbhMmoq0Q9bNU%2Bm8Dv28Q3UO24JXg7dk7ERtii-2U05uA%40mail.gmail.com.
