You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
(?) The format of the MeTTa documentation is an open question. It should be a set of HTML pages which contain the language tutorial and a reference of the standard library.
Python code should be documented using docstrings.
C API is written in Rust and should be commented in Rust using documentation comments. These comments then will be converted to the C API comments using cbindgen tool. After that comments from the C header could be converted into C API docs using Doxygen.
Add a separate CMake command (doc) to generate the documentation for the project.
The text was updated successfully, but these errors were encountered:
The C API docs are merged, and can be built with Doxygen 1.9.7. Next step is to get them published automatically and hosted on the web, which @wenwei-dev is taking care of.
This issue is to discuss and track the status of the documentation of the MeTTa functions and APIs we have at the moment.
List of APIs we have with their status:
cbindgen
tool. After that comments from the C header could be converted into C API docs using Doxygen.doc
) to generate the documentation for the project.The text was updated successfully, but these errors were encountered: