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.

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

support multiple versions for docs #675

Merged
merged 1 commit into from
Feb 9, 2023
Merged

Conversation

trey0
Copy link
Contributor

@trey0 trey0 commented Feb 9, 2023

Instead of generating documentation only for the develop branch, generate and push documentation to GitHub Pages for multiple branches (develop, master, ros2) and their tags. The generated web pages are modified to include a drop-down menu allowing you to switch versions. The default version is develop as before.

See deployed example: https://trey0.github.io/astrobee/

Maintenance notes:

  • A new version in the menu is added/updated when one of the branches in the list is pushed.
  • If the commit you push is a tagged release, a new version is created for the tag (this is a copy and it will persist when the branch is updated later). To ensure you generate docs for a tag, make sure you push the branch and the tag in the same push call, or else you'll have to run the docs workflow manually after you push the tag.
  • There is currently no mechanism to go back and generate docs versions for older tagged releases. (But not sure anyone needs that.)
  • To prune obsolete tagged releases out of the version list, you can manually check out the gh-pages branch, git rm -r the version folder, commit and push. (The menu options are auto-detected using the version folders.)

Copy link
Member

@marinagmoreira marinagmoreira left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really cool feature!!

@trey0 trey0 merged commit 967c098 into nasa:develop Feb 9, 2023
marinagmoreira added a commit that referenced this pull request Mar 9, 2023
* Documentation update (#668)

* docker docs update

* make build instructions ROS1

* updating install instructions, hopefully making them easier to follow

* updated from github PR reviews

* fix typo

* replace list with append (#671)

* ci: bump to checkout@v3 (#673)

* Unlatching topics (#674)

* Changed heartbeat topic to be unlatched.

* Changed echoed command to not latching.

* no subscribers and info is obtained by service, so no latched topic needed

* removing latched on frequently published topics

* Made command topic to not atching.

* no need for these to be latched

* sub and pub in same node, no need to latch

* no need to be latched no subs and not recorded, rviz should be opened when published

* Made ground bridge topics not latched.

* Fixed heartbeat topic latched comment.

---------

Co-authored-by: Katie Browne <kathryn.browne@nasa.gov>

* support multiple versions for docs (#675)

* Make coverage_analyzer.py support Python 3 (#680)

Refactor to simplify and make output identical between Python 2 and 3

* Release 0.17.0 (#683)

* add missing glog flag that caused problems in some systems (#685)

* Make isort repeatable (#694)

* make isort repeatable

* isort now consistently groups astrobee imports as first party; one-time update to apply to old files

* moving ff_names to ff_common, updating headers (#696)

---------

Co-authored-by: Trey Smith <trey.smith@nasa.gov>
Co-authored-by: Katie Browne <kathryn.browne@nasa.gov>
luisa-mao pushed a commit to luisa-mao/astrobee-1 that referenced this pull request Jul 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants