Is there a write up on how to contribute to Asymptote (asy code) and how contributions should be documented outside of commenting the code (multi line comments would help here).
Did you ever consider using Sphinx to document the Asymptote software package or applying to the Google summer of docs -
For contribution guidelines, we do not have yet a contribution guidelines though we do have style guides (for example, no spaces between assignment (int something=100; as opposed to int something = 100;).
As for asymptote documentation, I have proprosed earlier doxygen/javadoc-style comments (and perhaps with the ability to integrate with the language server protocol) - for example,
I wrote the original code but was not comfortable using Sphinx (All the
documentation I wrote was in LaTeX) so the code was taken over by
geometric algebra enthusiasts at Cambridge University and they are the
ones the wrote the online documentation (in addition to improving the code).
On 3/8/23 1:31 PM, Jamie wrote:
For contribution guidelines, we do not have yet a contribution
guidelines though we do have style guides (for example, no spaces
between assignment (|int something=100;| as opposed to |int something
= 100;|).
As for asymptote documentation, I have proprosed earlier
doxygen/javadoc-style comments (and perhaps with the ability to
integrate with the language server protocol) - for example,
Is there a write up on how to contribute to Asymptote (asy code) and how contributions should be documented outside of commenting the code (multi line comments would help here).
Did you ever consider using Sphinx to document the Asymptote software package or applying to the Google summer of docs -
https://opensource.googleblog.com/2022/02/Announcing%20Season%20of%20Docs%202022.html
For contribution guidelines, we do not have yet a contribution guidelines though we do have style guides (for example, no spaces between assignment (
int something=100;as opposed toint something = 100;).As for asymptote documentation, I have proprosed earlier doxygen/javadoc-style comments (and perhaps with the ability to integrate with the language server protocol) - for example,
though nothing has come out of it yet, and there has been disagreements on where to put the documentation.
Is this the sort of thing you were thinking about (It was done using
Sphinx) -
https://galgebra.readthedocs.io/en/latest/
I wrote the original code but was not comfortable using Sphinx (All the
documentation I wrote was in LaTeX) so the code was taken over by
geometric algebra enthusiasts at Cambridge University and they are the
ones the wrote the online documentation (in addition to improving the code).
On 3/8/23 1:31 PM, Jamie wrote: