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

Automate a deployment of docs to GitHub pages #28

Closed
BaldBeacon opened this issue Dec 9, 2019 · 2 comments · Fixed by #61 or #62
Closed

Automate a deployment of docs to GitHub pages #28

BaldBeacon opened this issue Dec 9, 2019 · 2 comments · Fixed by #61 or #62
Labels
enhancement

Comments

@BaldBeacon
Copy link

Having to build and open the documentation locally adds an extra step that could be mitigated by pushing the documentation of the current master commit to GitHub pages.

The process of uploading to GitHub pages is documented here
@skliper
Copy link
Contributor

skliper commented Mar 16, 2020

Related to nasa/cFE#560

From Circle CI instructions at https://circleci.com/blog/deploying-documentation-to-github-pages-with-continuous-integration/. Travis CI is likely similar.

Certainly a useful way to keep our doxygen documentation up to date. Need to trade approaches.

@skliper
Copy link
Contributor

skliper commented Mar 16, 2020

Travis guide: https://docs.travis-ci.com/user/deployment/pages/

skliper added a commit to skliper/cFS that referenced this issue Mar 26, 2020
@skliper
Fix nasa#28, Deploy documents to github
2a0c404
skliper added a commit to skliper/cFS that referenced this issue Mar 27, 2020
@skliper
Fix nasa#28, Deploy documents to github
107e3cf
skliper added a commit to skliper/cFS that referenced this issue Mar 28, 2020
@skliper
Fix nasa#28, Deploy documentation
9a31868 
Also fixes nasa#60, config warnings except for the new ones
introduced by using the latest deployment version
Also partially fixes nasa#47, removes permissive mode hack
Adds enforce of no doxygen warnings for osal and users guide
skliper added a commit to skliper/cFS that referenced this issue Mar 28, 2020
@skliper
Update CI for deploy docs, warnings, and simplify
928e3c0 
Fix nasa#28, Deploy documentation
Fix nasa#60, config warnings except for the new ones
introduced by using the latest deployment version
Fix nasa#47, removes permissive mode hack and updates README.md
Adds enforce of no doxygen warnings for osal and users guide
@skliper skliper mentioned this issue Mar 28, 2020
Merged
@astrogeco astrogeco mentioned this issue Apr 1, 2020
Merged
@skliper skliper mentioned this issue May 19, 2020
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
2 participants
@skliper @BaldBeacon