📝 Documentation Hosting

[liam-teale]

Overview

ZestCode needs its documentation available on GitHub pages

Motivation

I don't think I need to state why this is necessary

Requirements

• Doxygen should be used to generate documentation automatically
• Website needs to update automatically when a new stable release is made
• Be able to select version on documentation hosting site
• Contributor docs also included (CONTRIBUTING.md, STYLEGUIDE.md, etc)

Additional

[leoabubucker]

I created doxygen documentation. Two questions:

1. What, if any, directories or files should be excluded (i.e., /tests in /src)?
2. Can GitHub Pages be allowed on the repository? I have the html on my fork but the GitHub Pages tab throws this error: "Pages on this forked repository is disabled due to a policy enforced by the owner of the parent repository."

[liam-teale]

1: only the header files in the include directory should be used
2: I've changed the organization settings now, try again please

[leoabubucker]

https://leoabubucker.github.io/ZestCode/index.html
Let me know if there are any changes you want. I added "test commit" for testing, but everything else should be right. I'm working on a GitHub Automation to update the website every time there is a push to main. Would that satisfy the second implementation criteria?

[liam-teale]

Almost. We want the documentation to update whenever there's a new non-prerelease version created.

[liam-teale]

You should open a PR for this, it would be best to continue discussions there