search

symforce-org / symforce

Fast symbolic computation, code generation, and nonlinear optimization for robotics
https://symforce.org
Apache License 2.0
1.41k stars 145 forks source link

[SymForce] Auto-deploy docs on push to main #196

Closed bradley-solliday-skydio closed 2 years ago

bradley-solliday-skydio commented 2 years ago

This PR adds a github actions workflow to regenerate and push the symforce documentation to symforce-org/symforce-org.github.io.

This workflow only triggers on pushes to the main branch of symforce-org/symforce.

bradley-solliday-skydio commented 2 years ago

Here's the action running for the merging of this copy PR (https://github.com/symforce-org/symforce/pull/199) (the same, except triggered when merged into a branch other than main, and pushing the docs to a non-main branch)

https://github.com/symforce-org/symforce/runs/7400463271?check_suite_focus=true

aaron-skydio commented 2 years ago

This might already be on your radar, but we also need to 1) preserve files that aren't generated by sphinx (.nojekyll and CNAME I think) and 2) preferably exclude unnecessary build artifacts like .doctrees and .buildinfo, although that's more of a nice-to-have (but does make diffs much more readable)

bradley-solliday-skydio commented 2 years ago

Okay, that actually wasn't on my radar. By I've just adjusted the PR to remove the files you mentioned and add in the others (and include the sha in the commit message). Here's a link to easily view the changes: https://github.com/symforce-org/symforce/compare/6c8dfecf59606f63550264ed084551d7fb19c1a6..c8f7430c4bcfc0b55b3d063963e194ce0b5f6c43

Also, here's a screenshot of what main would look like after this workflow runs: image