Skip to content

Commit b6cafae

Browse files
author
Murilo Marinho
committed
[conf] Adding buttons for source, edit, suggest edit, and create issue
1 parent 9f4279b commit b6cafae

File tree

2 files changed

+17
-14
lines changed

2 files changed

+17
-14
lines changed

docs/source/conf.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,16 @@
4848
html_theme = 'sphinx_book_theme'
4949
# Tried with `furo` on May 23, 2025, but somehow it didn't look right. In particular the download button wasn't as clear.
5050
html_theme_options = {
51-
"announcement": "This tutorial has been updated to ROS2 Jazzy. "
51+
"announcement": "This tutorial has been updated to ROS2 Jazzy. "
5252
"See <a href='https://ros2-tutorial.readthedocs.io/en/humble/'>Humble Docs</a> for the previous version. "
5353
"Create an <a href='https://github.com/mmmarinho/ROS2_Tutorial/issues'>issue</a> for inconsistencies.",
54+
"repository_url": "https://github.com/mmmarinho/ROS2_Tutorial",
55+
"use_source_button": True,
56+
"repository_branch": "main",
57+
"path_to_docs": "docs/source",
58+
"use_repository_button": True,
59+
"use_edit_page_button": True,
60+
"use_issues_button": True,
5461
}
5562
html_title = project
5663

docs/source/index.rst

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,20 @@
1313

1414
`ROS2 Jazzy <https://docs.ros.org/en/jazzy/>`_ tutorials by `Murilo M. Marinho <https://murilomarinho.info/>`_, focusing on Ubuntu 24.04 x64 LTS and the programming practices of successful state-of-the-art robotics implementations such as the `SmartArmStack <https://smartarmstack.github.io>`_ also used in the `AISciencePlatform <https://github.com/AISciencePlatform>`_.
1515

16+
These tutorials have been the backbone of `EEEN62021 Software for Robotics <https://www.manchester.ac.uk/study/masters/courses/list/20967/msc-robotics/course-details/EEEN62021>`_, one of the units of the `MSc Robotics <https://www.manchester.ac.uk/study/masters/courses/list/20967/msc-robotics/>`_ at the `University of Manchester <https://www.manchester.ac.uk>`_.
17+
1618
🤟 **Using this tutorial**
1719

18-
This is a tutorial that supposes that the user will follow it linearly. Some readers can skip the :doc:`Preamble <preamble/ubuntu>` if they are somewhat already comfortable in Python and Ubuntu. Otherwise, all steps can be considered as dependent on the prior ones, starting from :doc:`ROS2 Setup <installation>`.
20+
This is a tutorial that supposes that the user will follow it linearly. Some readers can skip the :doc:`Preamble <preamble/ubuntu>` if they are somewhat already comfortable in Python and Ubuntu. Otherwise, all steps can be considered as dependent on the prior ones, starting from :doc:`ROS2 Setup <installation>`.
21+
22+
It is expected that the user will be working directly on an Ubuntu machine. :program:`Docker` images are available but no compatibility with host systems other than Ubuntu have been attempted.
1923

2024
❤️ **Ways to show love**
2125

22-
- ⭐ starring `the repository <https://github.com/mmmarinho/ROS2_Tutorial>`_.
23-
- Contributing with feedback to the `issue tracker <https://github.com/mmmarinho/ROS2_Tutorial/issues>`_.
24-
- Sending me an e-mail at [email protected].
26+
If you enjoyed this tutorial, please
27+
28+
- ⭐ star `the repository <https://github.com/mmmarinho/ROS2_Tutorial>`_ or,
29+
- contribute with feedback to the `issue tracker <https://github.com/mmmarinho/ROS2_Tutorial/issues>`_.
2530

2631
🔍 **Quick overview**
2732

@@ -150,15 +155,6 @@ This is a tutorial that supposes that the user will follow it linearly. Some rea
150155
cmake/index
151156
faq
152157

153-
Warnings
154-
--------
155-
156-
.. warning::
157-
If you're using macOS or Windows, this is **NOT** the guide for you. There might be a lot of overlap, but none of the code shown here has been tested on those operating systems.
158-
159-
.. warning::
160-
This project is under active development and is currently a draft.
161-
162158
Disclaimers
163159
-----------
164160

0 commit comments

Comments
 (0)