Migrate documentation to GitHub Pages

CMakePP / CMakePPLang

Object-oriented extension to the CMake language.

http://cmakepp.github.io/CMakePPLang/

Apache License 2.0

11 stars 4 forks source link

Migrate documentation to GitHub Pages #34

Closed zachcran closed 2 years ago

zachcran commented 2 years ago

Closes #27. Migrates documentation from Read the Docs to GitHub Pages to be consistent with the rest of CPP.

This PR will:

[x] Create a workflow to automatically generate and deploy documentation to GitHub Pages in the gh-pages branch.
[ ] Stop hosting the documentation on Read the Docs.

Questions:

[x] How is the documentation being uploaded/hosted on Read the Docs? I am not familiar with that workflow, but I do not see a GitHub workflow automatically uploading it.

ryanmrichard commented 2 years ago

The infrastructure for building and hosting the documentation on RTD lives on RTD. So once you get it building on GH Pages, I'll delete the RTD jobs.

zachcran commented 2 years ago

The deploy_docs.yml works on my fork, and it is temporarily hosted at https://zachcran.github.io/CMakePPCore/. @ryanmrichard Check it out and make sure everything looks right, then I think this PR is ready. I'll mark it ready for review.