vectorgraphics / asymptote

2D & 3D TeX-Aware Vector Graphics Language
https://asymptote.sourceforge.io/
GNU General Public License v3.0
542 stars 90 forks source link

geometry.asy documentation automatically updatable? #326

Closed jamadagni closed 2 years ago

jamadagni commented 2 years ago

I've been writing some additions for geometry.asy for my recent posts regarding it.

In this connection I notice the comments, but am not sure whether there exists a pipeline to continuously generate documentation from it.

The existing documentation itself does not reflect the existing API and only links to an old Web Archive version.

I also note that some new (?) functions do not have tags.

I have myself been using the API based on visual scan of geometry.asy and not just the (old) documentation.

Hence I am wondering whether the asyxml tags are meaningful and there is any method to automatically generate the documentation from it. Failing which another method for documentation might need to be chosen and all API whether documented already or not should be documented in that method.

johncbowman commented 2 years ago

I think the tool you are looking for is here: https://github.com/pivaldi/asymptote-geometry-documentation

ivankokan commented 2 years ago

A placeholder which we created few years ago: https://github.com/vectorgraphics/asymptote/wiki.

https://sourceforge.net/p/asymptote/discussion/409349/thread/f07c1fcf/?limit=25#c83c

I guess this is the summer to tackle some TODOs I have collected.