✨ Added Doxygen Doxyfile For Automated Documentation#49
Merged
liam-teale merged 40 commits intoZestCommunity:mainfrom Mar 4, 2025
Merged
✨ Added Doxygen Doxyfile For Automated Documentation#49liam-teale merged 40 commits intoZestCommunity:mainfrom
liam-teale merged 40 commits intoZestCommunity:mainfrom
Conversation
Member
|
Don't worry about GitHub pages. I like using readthedocs.io instead, as it will build the documentation for us. |
Contributor
Author
|
Changing to using readthedocs.io which does not require a separate dedicated branch and is cleaner overall. Good idea! Testing website here, will make a PR when I work out the formatting better: https://zestcode.readthedocs.io/en/latest/ |
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.
Overview
Adds Doxyfile in /docs to automatically generate documentation website for repository. This PR DOES NOT include the html files for documentation website as that is in a separate branch so a separate PR request.
Motivation
Public, and easy-to-access, documentation is needed for an open-source framework
References (optional)
Part of a fix that resolves #25
Implementation Details (optional)
See documentation website (the GitHub Page on my fork): ZestCode
Does not address automatic updating (needs to be manually re-deployed). Future PR request will introduce automatic updating.
It is recommended to have the website content in a separate branch, thus I have the website content in a gh-pages branch (what GitHub recommends it's named). I don't see a way to do a PR that creates a base gh-pages branch that I can merge my gh-pages branch to. Please advise.
Test Plan: