Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document MeTTa and APIs #319

Open
4 of 5 tasks
vsbogd opened this issue Jun 4, 2023 · 4 comments
Open
4 of 5 tasks

Document MeTTa and APIs #319

vsbogd opened this issue Jun 4, 2023 · 4 comments
Assignees
Labels
enhancement New feature or request

Comments

@vsbogd
Copy link
Collaborator

vsbogd commented Jun 4, 2023

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:

  1. (?) 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.
  2. Python code should be documented using docstrings.
  3. 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.
  4. Add a separate CMake command (doc) to generate the documentation for the project.
@vsbogd vsbogd added the enhancement New feature or request label Jun 17, 2023
@luketpeterson
Copy link
Contributor

luketpeterson commented Jun 28, 2023

I will take the C part of this task. However, is there a preferred style I should follow for the Doxygen comments?

@luketpeterson
Copy link
Contributor

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.

@vsbogd
Copy link
Collaborator Author

vsbogd commented Aug 16, 2024

https://metta-lang.dev and https://github.com/trueagi-io/metta-lang-dev solves the tutorial item

@vsbogd
Copy link
Collaborator Author

vsbogd commented Aug 16, 2024

Python documentation is solved in #416

@vsbogd vsbogd self-assigned this Aug 16, 2024
@vsbogd vsbogd pinned this issue Aug 16, 2024
@vsbogd vsbogd unpinned this issue Aug 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants