search

SoarGroup / SoarGroup.github.io

Soar's website: documentation, news, announcements, links, etc.
http://soar.eecs.umich.edu/
Other
4 stars 1 forks source link

Generate Soar programming reference from Doxygen comments and host here #15

Open garfieldnate opened 1 month ago

garfieldnate commented 1 month ago

Particularly an SML programming reference would be very helpful, since SWIG ignores Doxygen comments, and Python/Java, etc. developers are mostly flying blind. Whenever I need to understand something about the SML API, I search through Soar's C++ code for the original definition and read the comments there.

moschmdt commented 1 month ago

MkDoxy might be an opportunity but not without drawbacks I assume. MkDoxy this is based on the docs being in the same repository as the source code, but maybe this could be solved by integrating the Soar repository via reference as git submodule or via vcs tool.

garfieldnate commented 1 month ago

MkDoxy looks very cool! Thanks for finding that. I think I'd be happy enough just to have the CI checkout a shallow copy of Soar's source and build from there. It does make local website development more complicated, though, because I don't want to accidentally check in my local Soar source path to a configuration variable in this repo. Perhaps it would be possible to use an environment variable to specify the source location or something.