Draft: Migrate Sphinx and API documentation automatic build and upload to main repo

ros-industrial / easy_manipulation_deployment

A ROS2 package that allows rapid digitization of robotic work cells and ease of efficient path-planning of manipulators.

Apache License 2.0

48 stars 13 forks source link

Draft: Migrate Sphinx and API documentation automatic build and upload to main repo #7

Closed Briancbn closed 3 years ago

Briancbn commented 3 years ago

Don't merge this for now. I will rebase this before the next release.

I have added the following changes and repository configuration

[x] Github Actions for building and linting the Sphinx docs. (PR and master branch only)
[x] GA for building the Doxygen docs. (PR and master branch only)
[x] Upload built API Doxygen docs to github-pages branch. (master branch only)
[ ] Readthedoc Github Webhook setup.
[ ] Readthedoc PR build.
[ ] branch-off github-pages branch to ensure linear history.

gavanderhoorn commented 3 years ago

* Upload built API Doxygen docs to github-pages branch. (master branch only)

Something to take into account: this repository is now approx 300MB, which starts to take noticeable time when git cloneing.

As was noted in https://github.com/ros-industrial-consortium/tesseract/issues/603, pushing documentation to gh-pages branches in the same repository as the code can substantially increase download times.

Using a separate repository for hosting such documentation may be a better alternative.

Briancbn commented 3 years ago

Something to take into account: this repository is now approx 300MB, which starts to take noticeable time when git cloneing.

Noted on this, we had some back-and-forth on adding and removing the docs with some bad histories stuck in the commits. I think we will stick to hosting it on a separate repo then.