Closed dtemir closed 2 years ago
@jfResearchEng if you decide to merge it and put it on GitHub pages, you need to go to the repository Settings -> Pages -> make Source point at gh-pages
, root
to make everything work.
This is awesome Demir great work!!
Description
This PR adds a
sphinx
directory that takes the available documentation indocs
and converts them into an online website documentation.It also adds a new GitHub workflow to automatically deploy any changes to a
gh-pages
branch to keep it live on GitHub Pages. It is currently deployed on my fork, under https://temir.dev/labgraph/.But once merged to this repo, you can set it up to work with a URL similar to
https://github.io/facebookresearch/labgraph
Fixes #46
Type of change
Please delete options that are not relevant.
Feature/Issue validation/testing
The GitHub workflow should serve as a good test and can be run with the
workflow_dispatch
trigger.Checklist:
Big Shoutout to @navn-r for help with GitHub Actions