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

Build documentation using Sphinx #441

Merged
merged 59 commits into from
Jul 11, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
59 commits
Select commit Hold shift + click to select a range
7946324
Build documentation using Sphinx
azeey May 15, 2024
a6afd14
Build documentation using Sphinx
azeey May 15, 2024
5f30f92
Add documentation for Gazebo vendor packages
azeey May 21, 2024
e3049d5
Indicate that Gazebo Fortress is recommended for ROS 2 Humble and Iro…
azeey May 7, 2024
10742d5
Installing Gazebo11 side by side with new Gazebo Tutorial (#438)
j-rivero May 14, 2024
9795585
Minor updates on Noble references (#439)
j-rivero May 15, 2024
4d2759b
contributing.md: suggest multi-repo features target main (#440)
scpeters May 15, 2024
51b6f90
Build documentation using Sphinx
azeey May 15, 2024
9ab84fc
Enable 'edit this page'
azeey May 21, 2024
99fd22c
Suppress warnings for external links
azeey May 21, 2024
28c3b54
Update warning style
azeey Jun 3, 2024
dc03207
Handle dev and old versions, fix going to the correct page after vers…
azeey Jun 3, 2024
650a3e4
Use different background for eol vs supported versions
azeey Jun 3, 2024
c9ab794
Add .gitignore
azeey Jun 3, 2024
7653220
Add /libs
azeey Jun 4, 2024
7582ec7
Refactor
azeey Jun 4, 2024
289cacb
Fetch content from github
azeey Jun 4, 2024
65fcaf6
Add individual library pages
azeey Jun 4, 2024
ba16cad
Add support for "latest" and "all"
azeey Jun 4, 2024
66b4cf1
Merge remote-tracking branch 'origin/master' into gz_vendor_pkgs
azeey Jun 4, 2024
44a1f69
Check if symlink already exists
azeey Jun 4, 2024
bf0f3ce
Fix formatting of /libs pagse
azeey Jun 4, 2024
99eb778
Add redirect from /docs
azeey Jun 4, 2024
d5f3024
Share conf.py file between docs and libs
azeey Jun 4, 2024
f0e8e85
Add option for building pointers
azeey Jun 4, 2024
3807824
Customize footer
azeey Jun 5, 2024
b8ca4cb
Add more menu items, tweak style
azeey Jun 5, 2024
7a363ed
Add option to specify output directory, build libs only
azeey Jun 5, 2024
ffef1b4
Remove .github from .gitignore
azeey Jun 5, 2024
32361de
Add deployment workflow
azeey Jun 5, 2024
a8fc361
Merge branch 'gz_vendor_pkgs' into sphinx_docs
azeey Jun 5, 2024
83f6449
Merge remote-tracking branch 'origin/master' into sphinx_docs
azeey Jun 5, 2024
751d271
Use branch that supports GA, fix path
azeey Jun 5, 2024
afbc9cd
Set base-href so frontend website works even when deployed to a githu…
azeey Jun 5, 2024
9dc4e25
Fix npm command
azeey Jun 5, 2024
b55f9cc
Add pointer pages
azeey Jun 5, 2024
32d1e73
Add GZ_DEPLOY_URL
azeey Jun 5, 2024
8fdd22b
Fix base-href usage, use GZ_DEPLOY_URL in more places
azeey Jun 6, 2024
346718c
Update on-push branches. $default-branch only works on workflow templ…
azeey Jun 6, 2024
74b46dc
Use full base url for base-href
azeey Jun 6, 2024
972736e
Fix warning banner link, add favicon, use subprocess to run sphinx
azeey Jun 6, 2024
d4bfbb0
Treat all links as external, fix warnings
azeey Jun 6, 2024
7f4d8e1
Fix scroll padding
azeey Jun 6, 2024
12d605c
Fix all warnings
azeey Jun 6, 2024
c9bd06b
WIP
azeey Jun 26, 2024
ef5ac69
Merge remote-tracking branch 'origin/master' into azeey/sphinx_docs
azeey Jul 2, 2024
ad14a78
Merge remote-tracking branch 'origin/master' into sphinx_docs
azeey Jul 2, 2024
6744a27
Deploy to gh-pagse
azeey Jul 2, 2024
b9af76b
Keep files
azeey Jul 2, 2024
eff9088
Update permissions
azeey Jul 2, 2024
c9c68bb
Test on test_sphinx_docs
azeey Jul 2, 2024
268ea01
Parallel builds
azeey Jul 2, 2024
4366b60
Fix upload
azeey Jul 2, 2024
ec8d140
Fix yaml
azeey Jul 2, 2024
cd5e151
Add concurrency
azeey Jul 2, 2024
14684e5
Merge branch 'test_sphinx_docs' into azeey/sphinx_docs
azeey Jul 2, 2024
e44c638
Remove test_sphinx_docs
azeey Jul 2, 2024
c08ad3b
Use `main` branch of gazebosim-web-frontend
azeey Jul 11, 2024
37d8790
Merge remote-tracking branch 'origin/master' into azeey/sphinx_docs
azeey Jul 11, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Installing Gazebo11 side by side with new Gazebo Tutorial (#438)
* Installing Gazebo11 side by side with new Gazebo Tutorial
---------

Signed-off-by: Jose Luis Rivero <jrivero@osrfoundation.org>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
  • Loading branch information
2 people authored and azeey committed May 21, 2024
commit 10742d56722bf850acf89f09fdd5038b6dfee66f
5 changes: 4 additions & 1 deletion garden/install_ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ Garden binaries are provided for Ubuntu Focal and Jammy. The
Garden binaries are hosted in the packages.osrfoundation.org repository.
To install all of them, the metapackage `gz-garden` can be installed.

**WARNING:** `gz-garden` cannot be installed alongside gazebo-classic (eg. `gazebo11`) since both use the `gz` command line tool. Trying to install `gz-garden` on a system that already has gazebo-classic installed from binaries will cause gazebo-classic and its dependencies to be uninstalled. Currently, the workarounds for this are to install from source or to use Docker [`gazebo-classic`](https://hub.docker.com/_/gazebo) so they are not installed side-by-side on the same system.
**WARNING:** for gazebo-classic (eg. `gazebo11`) users: `gz-garden` cannot be
installed alongside with `gazebo11` by default. To facilitate the migration
this can be done using the instruction detailed in
[Installing Gazebo11 side by side with new Gazebo](/docs/all/install_gz11_side_by_side).

First install some necessary tools:

Expand Down
7 changes: 5 additions & 2 deletions harmonic/install_ubuntu.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# Binary Installation on Ubuntu

Harmonic binaries are provided for Ubuntu Jammy (22.04) and Ubuntu 24.04 (when it's released). The
Harmonic binaries are provided for Ubuntu Jammy (22.04) and Ubuntu Noble (24.04). The
Harmonic binaries are hosted in the packages.osrfoundation.org repository.
To install all of them, the metapackage `gz-harmonic` can be installed.

**WARNING:** `gz-harmonic` cannot be installed alongside gazebo-classic (eg. `gazebo11`) since both use the `gz` command line tool. Trying to install `gz-harmonic` on a system that already has gazebo-classic installed from binaries will cause gazebo-classic and its dependencies to be uninstalled. Currently, the workarounds for this are to install from source or to use Docker [`gazebo-classic`](https://hub.docker.com/_/gazebo) so they are not installed side-by-side on the same system.
*WARNING:** for gazebo-classic (eg. `gazebo11`) users: `gz-harmonic` cannot be
installed alongside with `gazebo11` by default. To facilitate the migration
this can be done using the instruction detailed in
[Installing Gazebo11 side by side with new Gazebo](/docs/all/install_gz11_side_by_side).

First install some necessary tools:

Expand Down
71 changes: 71 additions & 0 deletions install_gz11_side_by_side.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Installing Gazebo11 side by side with new Gazebo

## Supported Gazebo versions and Ubuntu platforms for this tutorial

This tutorial affects the Gazebo Classic users on Ubuntu `Jammy` (latest
Ubuntu release were Gazebo Classic packages supported by the Gazebo team)
that plan on migrating code to new Gazebo `Fortress`, `Garden` or `Harmonic.`

There is no guarantee that the Gazebo Classic version detailed in this document
will be updated in any case. Please consider the migration to the new Gazebo
as the recommended alternative.

## General context and migrations to new Gazebo

New versions of Gazebo can not be installed together with Gazebo Classic
(aka `gazebo11`) since both use the `gz` command line tool. Trying to
install `gz-garden` or `gz-harmonic` from `packages.osrfoundation.org`
on a system that already has gazebo-classic installed from binaries
will cause gazebo-classic and its dependencies to be uninstalled.

Having a side by side installation of both can make easier the recommended
migration to newer versions of Gazebo.

## Alternative approach for Gazebo Classic without the gz tool

A possible workaround could be to use Gazebo Classic without the `gz`
command or with a renamed `gz` command. This can be particularly
interesting since the ROS (Robot Operative System) wrapper known as
`gazebo_ros_pkgs` do not use the `gz` command but the `gzserver` and
`gzclient` commands.

Not shipping the `gz` command by default in a Gazebo Classic installation
would be a disruptive change for existing users so it should not be hosted in
`packages.osrfoundation.org`.

## Gazebo11 with a separate gz tool package

This alterntive approach has been implemented and packages for `jammy` are
hosted in the Open Robotics `gazebo11-gz-cli` PPA:
https://launchpad.net/~openrobotics/+archive/ubuntu/gazebo11-gz-cli

The PPA contains a `gazebo11` version that ships the `gz` executable in
an independent packages called `gazebo11-gz-cli` while the main `gazebo11`
package has a `gz11` command. Both are really symlinks to `gz-11.x.y`.

### How the packaging works for the gz command

The `gazebo11-gz-cli` is a soft dependency on `gazebo11`. It is installed
by default but it will be uninstalled when installing the new Gazebo
packages and the effect is that the `gz` command for Gazebo Classic replaced
by the `gz` tool from new Gazebo. The `gz11` command can be used instead of
the `gz` command to access to the same functionality.

## Installing the new packaging from the PPA

From an existing `gazebo11` installation (on `jammy` the Ubuntu official
repositories will install `11.10.2+dfsg-1` version) or a non existing
`gazebo11` installation the steps are the following:

```bash
sudo add-apt-repository ppa:openrobotics/gazebo11-gz-cli
sudo apt update
sudo apt-get install gazebo11
```

If `gazebo11` was installed before, it will be upgraded to the version in the
PPA. From this point, a new Gazebo installation for `fortress`, `garden` or
`harmonic` can be executed.

If a new Gazebo installation was installed before, the `gazebo11-gz-cli` package
won't be installed.