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

[Feature] Amber Docs generator #108

Open
4 of 5 tasks
Ph0enixKM opened this issue May 25, 2024 · 2 comments · May be fixed by #62
Open
4 of 5 tasks

[Feature] Amber Docs generator #108

Ph0enixKM opened this issue May 25, 2024 · 2 comments · May be fixed by #62
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Ph0enixKM
Copy link
Collaborator

Ph0enixKM commented May 25, 2024

Create a way to generate documentation. The implementation should:

  1. Generate each markdown file for each module that is part of the project
  2. Collect freestanding comment docs as documentation body
  3. Aggregate comment docs that are directly above function declarations as the function documentation

Checklist

  • Create Comment Doc syntax module
  • Produce Markdown output
  • Handle importing - perhaps save the ready translation to a new file
  • Create an AST traversing mechanism to aggregate all translations
  • Detect Comment Doc when parsing functions
@Ph0enixKM Ph0enixKM linked a pull request May 25, 2024 that will close this issue
@Ph0enixKM Ph0enixKM self-assigned this May 25, 2024
@Ph0enixKM Ph0enixKM changed the title ✨ Docs Generator ✨ Amber Docs generator May 25, 2024
@Mte90
Copy link
Member

Mte90 commented Jun 12, 2024

I suggest also for the std in this way we document the code where the code is

@Ph0enixKM
Copy link
Collaborator Author

Yes. That is the main goal to automatically document stdlib

@Ph0enixKM Ph0enixKM added this to the Amber 0.4.0-alpha milestone Jun 17, 2024
@Mte90 Mte90 added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 24, 2024
@Ph0enixKM Ph0enixKM changed the title ✨ Amber Docs generator [Feature] Amber Docs generator Jul 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants