ci: auto-generate docs with Natural Docs + GitHub Pages#103
Merged
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the project's documentation process by automating the generation and deployment of API documentation. By integrating Natural Docs v2 with a GitHub Actions workflow, the project ensures that its documentation is consistently up-to-date and readily accessible via GitHub Pages, eliminating the need for manual updates and improving overall maintainability. Highlights
Changelog
Ignored Files
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request automates the documentation generation process by integrating Natural Docs with a GitHub Actions workflow. It removes the old, manually generated documentation from the docs/ directory and adds the necessary Natural Docs project configuration. The .gitignore file is updated to exclude the new documentation output directory. The changes look good and align with the goal of automating documentation deployment to GitHub Pages.
Note: Security Review did not run due to the size of the PR.
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
1 participant
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.
Summary
NaturalDocs.Project/) with SQF language supportmaindocs/HTML (generated manually 3 years ago by Natural Docs v1.52)docs-output/(CI-generated, never committed)How it works
The workflow triggers on pushes to
mainwhenaddons/**orNaturalDocs.Project/**change. It installs .NET 8 + Natural Docs 2.3.1, runs it againstaddons/, and deploys the output to GitHub Pages athttps://ocap2.github.io/addon/.Documentation is generated from the existing
/* ... */comment blocks in SQF files (27 of 48 files already have Natural Docs headers).After merge
GitHub Pages source needs to be set to "GitHub Actions" in repo Settings > Pages. The first push to
mainafter that will trigger the deployment.