Skip to content

Add Makefile target for generating api.md documentation #106

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

Merged
merged 4 commits into from
Apr 17, 2025

Conversation

devin-ai-integration[bot]
Copy link
Contributor

Add Makefile Target for Generating API Documentation

This PR adds a Makefile target for automatically generating the api.md documentation file. This allows for easier maintenance of the API documentation by providing a simple command to regenerate it when needed.

Added Makefile Target

make generate-api-docs

This target:

  • Installs required dependencies (doxypypy)
  • Sets up the necessary environment
  • Runs Doxygen to generate XML documentation
  • Uses moxygen to convert XML to markdown in docs/api.md

Link to Devin run: https://app.devin.ai/sessions/fd01c8097736469f9edc331366d54b3d
Requested by: [email protected]

Copy link
Contributor Author

Original prompt from [email protected]:

Received message in Slack channel #devin:

@Devin can you take a look at the `docs/api.md` file in the note-python repo and cross check it against the `notecard` Python module? Can you tell me which APIs, if any, are missing?

Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@Bucknalla Bucknalla self-requested a review April 17, 2025 17:30
@Bucknalla Bucknalla merged commit 8f66a36 into main Apr 17, 2025
6 checks passed
@Bucknalla Bucknalla deleted the devin/1744842338-api-md-generation branch April 17, 2025 17:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant