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.

Sign up for GitHub

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

Jump to bottom

Generate automatically some documentation for the Perl code #5568

Merged
merged 19 commits into from
Aug 31, 2021
Merged

Generate automatically some documentation for the Perl code #5568

merged 19 commits into from
Aug 31, 2021

Conversation

teolemon
Copy link
Member

@teolemon teolemon commented Aug 29, 2021 •
edited
Loading

What

Generate automatically some documentation for the Perl code and publish it to GitHub Pages

https://openfoodfacts.github.io/openfoodfacts-server/

Part of

@teolemon
generate-doc-automatically
ce78632 
generate-doc-automatically
@teolemon teolemon requested a review from a team as a code owner August 29, 2021 18:19
@teolemon teolemon added the 📚 Documentation Documentation issues improve the project for everyone. label Aug 29, 2021
@stephanegigandet
Copy link
Contributor

FYI, there's a script to generate the documentation using pod2html here:

#3054

The output is here:

https://world.openfoodfacts.org/files/doc/perl/index.html

@teolemon teolemon changed the title [WIP] Generate automatically some documentation for the Perl code Generate automatically some documentation for the Perl code Aug 31, 2021
@teolemon teolemon requested a review from hangy August 31, 2021 08:50
@teolemon teolemon mentioned this pull request Aug 31, 2021
Open
@teolemon teolemon requested a review from a team August 31, 2021 09:05
@teolemon teolemon added the GitHub Actions Pull requests that update Github_actions code label Aug 31, 2021
@sonarcloud
Copy link

sonarcloud bot commented Aug 31, 2021

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@teolemon teolemon merged commit db24306 into main Aug 31, 2021
@teolemon teolemon deleted the generate-doc-automatically branch August 31, 2021 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hangy hangy hangy approved these changes

Assignees
No one assigned
Labels
📚 Documentation Documentation issues improve the project for everyone. GitHub Actions Pull requests that update Github_actions code
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@teolemon @stephanegigandet @hangy @VaiTon