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.

Sign up for GitHub

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

Jump to bottom

Build documentation using Sphinx #441

Open
wants to merge 57 commits into
base: master
Choose a base branch
from
Open

Build documentation using Sphinx #441

wants to merge 57 commits into from

Commits on May 15, 2024

  1. Build documentation using Sphinx 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed May 15, 2024
    Configuration menu
    Copy the full SHA
    7946324 View commit details
    Browse the repository at this point in the history

  2. Build documentation using Sphinx 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed May 15, 2024
    Configuration menu
    Copy the full SHA
    a6afd14 View commit details
    Browse the repository at this point in the history

Commits on May 21, 2024

  1. Add documentation for Gazebo vendor packages 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed May 21, 2024
    Configuration menu
    Copy the full SHA
    5f30f92 View commit details
    Browse the repository at this point in the history

  2. Indicate that Gazebo Fortress is recommended for ROS 2 Humble and Iro… 

    …n users (#437)

Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed May 21, 2024
    Configuration menu
    Copy the full SHA
    e3049d5 View commit details
    Browse the repository at this point in the history

  3. 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>
    @j-rivero @ahcorde @azeey
    2 people authored and azeey committed May 21, 2024
    Configuration menu
    Copy the full SHA
    10742d5 View commit details
    Browse the repository at this point in the history

  4. Minor updates on Noble references (#439) 

    Signed-off-by: Jose Luis Rivero <jrivero@osrfoundation.org>
    @j-rivero @azeey
    j-rivero authored and azeey committed May 21, 2024
    Configuration menu
    Copy the full SHA
    9795585 View commit details
    Browse the repository at this point in the history

  5. contributing.md: suggest multi-repo features target main (#440) 

    Signed-off-by: Steve Peters <scpeters@openrobotics.org>
    @scpeters @azeey
    scpeters authored and azeey committed May 21, 2024
    Configuration menu
    Copy the full SHA
    4d2759b View commit details
    Browse the repository at this point in the history

  6. Build documentation using Sphinx 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed May 21, 2024
    Configuration menu
    Copy the full SHA
    51b6f90 View commit details
    Browse the repository at this point in the history

  7. Enable 'edit this page' 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed May 21, 2024
    Configuration menu
    Copy the full SHA
    9ab84fc View commit details
    Browse the repository at this point in the history

  8. Suppress warnings for external links 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed May 21, 2024
    Configuration menu
    Copy the full SHA
    99fd22c View commit details
    Browse the repository at this point in the history

Commits on Jun 3, 2024

  1. Update warning style 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 3, 2024
    Configuration menu
    Copy the full SHA
    28c3b54 View commit details
    Browse the repository at this point in the history

  2. Handle dev and old versions, fix going to the correct page after vers… 

    …ion selection

Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 3, 2024
    Configuration menu
    Copy the full SHA
    dc03207 View commit details
    Browse the repository at this point in the history

  3. Use different background for eol vs supported versions 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 3, 2024
    Configuration menu
    Copy the full SHA
    650a3e4 View commit details
    Browse the repository at this point in the history

  4. Add .gitignore 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 3, 2024
    Configuration menu
    Copy the full SHA
    c9ab794 View commit details
    Browse the repository at this point in the history

Commits on Jun 4, 2024

  1. Add /libs 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 4, 2024
    Configuration menu
    Copy the full SHA
    7653220 View commit details
    Browse the repository at this point in the history

  2. Refactor 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 4, 2024
    Configuration menu
    Copy the full SHA
    7582ec7 View commit details
    Browse the repository at this point in the history

  3. Fetch content from github 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 4, 2024
    Configuration menu
    Copy the full SHA
    289cacb View commit details
    Browse the repository at this point in the history

  4. Add individual library pages 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 4, 2024
    Configuration menu
    Copy the full SHA
    65fcaf6 View commit details
    Browse the repository at this point in the history

  5. Add support for "latest" and "all" 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 4, 2024
    Configuration menu
    Copy the full SHA
    ba16cad View commit details
    Browse the repository at this point in the history

  6. Merge remote-tracking branch 'origin/master' into gz_vendor_pkgs 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 4, 2024
    Configuration menu
    Copy the full SHA
    66b4cf1 View commit details
    Browse the repository at this point in the history

  7. Check if symlink already exists 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 4, 2024
    Configuration menu
    Copy the full SHA
    44a1f69 View commit details
    Browse the repository at this point in the history

  8. Fix formatting of /libs pagse 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 4, 2024
    Configuration menu
    Copy the full SHA
    bf0f3ce View commit details
    Browse the repository at this point in the history

  9. Add redirect from /docs 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 4, 2024
    Configuration menu
    Copy the full SHA
    99eb778 View commit details
    Browse the repository at this point in the history

  10. Share conf.py file between docs and libs 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 4, 2024
    Configuration menu
    Copy the full SHA
    d5f3024 View commit details
    Browse the repository at this point in the history

  11. Add option for building pointers 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 4, 2024
    Configuration menu
    Copy the full SHA
    f0e8e85 View commit details
    Browse the repository at this point in the history

Commits on Jun 5, 2024

  1. Customize footer 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 5, 2024
    Configuration menu
    Copy the full SHA
    3807824 View commit details
    Browse the repository at this point in the history

  2. Add more menu items, tweak style 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 5, 2024
    Configuration menu
    Copy the full SHA
    b8ca4cb View commit details
    Browse the repository at this point in the history

  3. Add option to specify output directory, build libs only 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 5, 2024
    Configuration menu
    Copy the full SHA
    7a363ed View commit details
    Browse the repository at this point in the history

  4. Remove .github from .gitignore 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 5, 2024
    Configuration menu
    Copy the full SHA
    ffef1b4 View commit details
    Browse the repository at this point in the history

  5. Add deployment workflow 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 5, 2024
    Configuration menu
    Copy the full SHA
    32361de View commit details
    Browse the repository at this point in the history

  6. Merge branch 'gz_vendor_pkgs' into sphinx_docs

    @azeey
    azeey committed Jun 5, 2024
    Configuration menu
    Copy the full SHA
    a8fc361 View commit details
    Browse the repository at this point in the history

  7. Merge remote-tracking branch 'origin/master' into sphinx_docs 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 5, 2024
    Configuration menu
    Copy the full SHA
    83f6449 View commit details
    Browse the repository at this point in the history

  8. Use branch that supports GA, fix path 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 5, 2024
    Configuration menu
    Copy the full SHA
    751d271 View commit details
    Browse the repository at this point in the history

  9. Set base-href so frontend website works even when deployed to a githu… 

    …b project page

Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 5, 2024
    Configuration menu
    Copy the full SHA
    afbc9cd View commit details
    Browse the repository at this point in the history

  10. Fix npm command 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 5, 2024
    Configuration menu
    Copy the full SHA
    9dc4e25 View commit details
    Browse the repository at this point in the history

  11. Add pointer pages 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 5, 2024
    Configuration menu
    Copy the full SHA
    b55f9cc View commit details
    Browse the repository at this point in the history

  12. Add GZ_DEPLOY_URL 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 5, 2024
    Configuration menu
    Copy the full SHA
    32d1e73 View commit details
    Browse the repository at this point in the history

Commits on Jun 6, 2024

  1. Fix base-href usage, use GZ_DEPLOY_URL in more places 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 6, 2024
    Configuration menu
    Copy the full SHA
    8fdd22b View commit details
    Browse the repository at this point in the history

  2. Update on-push branches. $default-branch only works on workflow templ… 

    …ates

Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 6, 2024
    Configuration menu
    Copy the full SHA
    346718c View commit details
    Browse the repository at this point in the history

  3. Use full base url for base-href 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 6, 2024
    Configuration menu
    Copy the full SHA
    74b46dc View commit details
    Browse the repository at this point in the history

  4. Fix warning banner link, add favicon, use subprocess to run sphinx 

    Using subprocess is necessary so the configurations of the /libs and /docs
builds don't interfere with each other.

Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 6, 2024
    Configuration menu
    Copy the full SHA
    972736e View commit details
    Browse the repository at this point in the history

  5. Treat all links as external, fix warnings 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 6, 2024
    Configuration menu
    Copy the full SHA
    d4bfbb0 View commit details
    Browse the repository at this point in the history

  6. Fix scroll padding 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 6, 2024
    Configuration menu
    Copy the full SHA
    7f4d8e1 View commit details
    Browse the repository at this point in the history

  7. Fix all warnings 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 6, 2024
    Configuration menu
    Copy the full SHA
    12d605c View commit details
    Browse the repository at this point in the history

Commits on Jun 26, 2024

  1. WIP 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    c9bd06b View commit details
    Browse the repository at this point in the history

Commits on Jul 2, 2024

  1. Merge remote-tracking branch 'origin/master' into azeey/sphinx_docs

    @azeey
    azeey committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    ef5ac69 View commit details
    Browse the repository at this point in the history

  2. Merge remote-tracking branch 'origin/master' into sphinx_docs 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    ad14a78 View commit details
    Browse the repository at this point in the history

  3. Deploy to gh-pagse 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    6744a27 View commit details
    Browse the repository at this point in the history

  4. Keep files 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    b9af76b View commit details
    Browse the repository at this point in the history

  5. Update permissions 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    eff9088 View commit details
    Browse the repository at this point in the history

  6. Test on test_sphinx_docs 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    c9c68bb View commit details
    Browse the repository at this point in the history

  7. Parallel builds 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    268ea01 View commit details
    Browse the repository at this point in the history

  8. Fix upload 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    4366b60 View commit details
    Browse the repository at this point in the history

  9. Fix yaml 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    ec8d140 View commit details
    Browse the repository at this point in the history

  10. Add concurrency 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    cd5e151 View commit details
    Browse the repository at this point in the history

  11. Merge branch 'test_sphinx_docs' into azeey/sphinx_docs 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    14684e5 View commit details
    Browse the repository at this point in the history

  12. Remove test_sphinx_docs 

    Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
    @azeey
    azeey committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    e44c638 View commit details
    Browse the repository at this point in the history