feat: Built Generate automatic documentation from code feature#71
Open
chaitanyarai19 wants to merge 33 commits intoopenfoodfacts:developfrom
Open
feat: Built Generate automatic documentation from code feature#71chaitanyarai19 wants to merge 33 commits intoopenfoodfacts:developfrom
chaitanyarai19 wants to merge 33 commits intoopenfoodfacts:developfrom
Conversation
Add MkDocs setup with GitHub Actions
…evelop chore(develop): release 0.4.0
Add MkDocs setup with GitHub Actions
Add MkDocs setup with GitHub Actions
Add MkDocs setup with GitHub Actions
Add MkDocs setup with GitHub Actions
Add MkDocs setup with GitHub Actions
updated index.md file
updated formate of code
updated code to make documentation of entire code
This reverts commit 9f19e20.
guideline file added
|
teolemon
changed the title
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
It includes a Python script (generate_features.py) that scans all .php files, extracts function details from docblocks, and generates features.md file.
The features.md file is integrated into the MkDocs documentation and hosted on GitHub Pages.
A post-commit Git hook has been added to automate the generation and inclusion of the features.md file in commits.
Screenshot
Fixes bug(s)
Part of
Generate automatic documentation from code #64