diff --git a/source/Concepts/Intermediate/About-RQt.rst b/source/Concepts/Intermediate/About-RQt.rst index f378755d15..3268b9a595 100644 --- a/source/Concepts/Intermediate/About-RQt.rst +++ b/source/Concepts/Intermediate/About-RQt.rst @@ -51,11 +51,6 @@ Installing From debs sudo apt install ros-{DISTRO}-rqt* -Building From Source -^^^^^^^^^^^^^^^^^^^^ - -See :doc:`Building RQt from Source <../../How-To-Guides/RQt-Source-Install>`. - RQt Components Structure ------------------------ diff --git a/source/How-To-Guides.rst b/source/How-To-Guides.rst index 06c4c66ad0..cdddb0d6b2 100644 --- a/source/How-To-Guides.rst +++ b/source/How-To-Guides.rst @@ -36,7 +36,6 @@ If you are new and looking to learn the ropes, start with the :doc:`Tutorials ` to install dependencies for RQt. - rosdep install error ``homebrew: Failed to detect successful installation of [qt5]`` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ While following the :doc:`Creating a workspace <../Tutorials/Beginner-Client-Libraries/Creating-A-Workspace/Creating-A-Workspace>` tutorial, you might encounter the following error stating that ``rosdep`` failes to install Qt5. diff --git a/source/How-To-Guides/RQt-Source-Install-MacOS.rst b/source/How-To-Guides/RQt-Source-Install-MacOS.rst deleted file mode 100644 index c1d6b459ff..0000000000 --- a/source/How-To-Guides/RQt-Source-Install-MacOS.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. redirect-from:: - - RQt-Source-Install-MacOS - Guides/RQt-Source-Install-MacOS - -Building RQt from source on macOS -================================= - -This page provides specific information to building RQt from source on macOS. -Follow these instructions before proceeding with :doc:`RQt Source Install ` page. - -System Requirements -------------------- - -RQt is supported on macOS 10.12, but 10.13 also seems to work. - -Dependencies ------------- - -The primary dependencies of the RQt package are sip and PyQt5. -PySide2 may be supported in the future. - -Install dependencies -^^^^^^^^^^^^^^^^^^^^ - -.. code-block:: bash - - $ brew install sip pyqt5 - $ brew install graphviz - $ python3 -m pip install pygraphviz pydot - $ brew link --force qt - -This is the quickest solution but may cause issues when upgrading Qt or if other packages are expecting Qt 4. -Another option is to update your ``PATH`` and ``CMAKE_PREFIX_PATH`` to include the Qt install location: - - .. code-block:: bash - - $ export PATH="$(brew --prefix qt)/bin:$PATH" - $ export CMAKE_PREFIX_PATH="$(brew --prefix qt):$CMAKE_PREFIX_PATH" - -Install RQt by source ---------------------- - -Continue with the :doc:`RQt source install page `. diff --git a/source/How-To-Guides/RQt-Source-Install-Windows10.rst b/source/How-To-Guides/RQt-Source-Install-Windows10.rst deleted file mode 100644 index 6502d72309..0000000000 --- a/source/How-To-Guides/RQt-Source-Install-Windows10.rst +++ /dev/null @@ -1,94 +0,0 @@ -.. redirect-from:: - - RQt-Source-Install-Windows10 - Guides/RQt-Source-Install-Windows10 - -Building RQt from source on Windows 10 -====================================== - -This page provides specific information to building RQt from source on Windows. -Follow these instructions before proceeding with the :doc:`RQt Source Install ` page. - -If you have not done so, follow the :doc:`ROS 2 Windows Development Setup guide <../Installation/Alternatives/Windows-Development-Setup>` before continuing. - -System Requirements -------------------- - -* Windows 10 -* Visual Studio 15.7.6 - -Currently Visual Studio 15.8 fails to build ROS 2 (`see issue `__). -Older versions of VS can be found `here `__. - - -Dependencies ------------- - -The primary dependencies of the RQt package are sip and PyQt5. -PySide2 may be supported in the future. -Even though they are provided through PyPI and chocolatey, you must install them by source to get compatible versions. - -Install sip by source -^^^^^^^^^^^^^^^^^^^^^ - -Download from https://www.riverbankcomputing.com/software/sip/download - -Run the x64 Native Tools Command Prompt as Administrator, and ``cd`` to the uncompressed source directory. - -Run: - -.. code-block:: bat - - python3 configure.py - nmake - nmake install - -If ``python3`` is installed on your system as ``python``, be sure to use that program name instead. - -Install PyQt5 by source -^^^^^^^^^^^^^^^^^^^^^^^ - -Download from https://www.riverbankcomputing.com/software/pyqt/download5 - -Run the x64 Native Tools Command Prompt as Administrator, and ``cd`` to the uncompressed source directory. -I ran into trouble with Qt 5.11.3 and PyQt5 compiling QtNfc, but it can be easily disabled. - -.. code-block:: bat - - python3 configure.py --disable QtNfc - nmake - nmake install - -Test that it works -^^^^^^^^^^^^^^^^^^ - -If install occurred without failure, try the commands below. -They should run without issue and you should see 4.19.13 as your ``sip.exe`` version. - -.. code-block:: bat - - sip -V - python3 -c "from PyQt5 import QtCore" - - -Other dependencies -^^^^^^^^^^^^^^^^^^ - -Install GraphViz from https://graphviz.gitlab.io/_pages/Download/Download_windows.html. - -Install ``pydot`` and ``pyparsing``: - -.. code-block:: bat - - pip3 install pydot pyparsing - - -PyGraphViz is a test dependency of ``qt_dotgraph``, but it is currently unsupported on Windows and building by source is not straight forward. -Manually merging this patch is the currently recommended solution (not verified): -`pygraphviz patch `__ - - -Install RQt by source ---------------------- - -Continue with the :doc:`RQt source install page `. diff --git a/source/How-To-Guides/RQt-Source-Install.rst b/source/How-To-Guides/RQt-Source-Install.rst deleted file mode 100644 index a91fc5ceff..0000000000 --- a/source/How-To-Guides/RQt-Source-Install.rst +++ /dev/null @@ -1,110 +0,0 @@ -.. redirect-from:: - - RQt-Source-Install - Guides/RQt-Source-Install - -Building RQt from source -======================== - -We've provided our development setup here to aid future users in easily extending RQt by creating their own plugins. -We encourage you to contribute those plugins back to the ``ros-visualization`` GitHub repository! - -System Requirements -------------------- - -These instructions are written for the target platforms for Crystal Clemmys (see `REP `__). - -- Ubuntu Bionic Beaver 18.04 64-bit -- Mac OSX Sierra 10.12.x -- Windows 10 with Visual Studio 2017 - -Other Requirements -^^^^^^^^^^^^^^^^^^ - -- In ROS 2 Crystal the minimum Qt version is ``Qt5`` - -Building From Source --------------------- - -In order to build RQt from source, first create a ROS 2 workspace at ``~/ros2_ws/``. -This is step is already covered in :doc:`building ROS 2 from source instructions <../Installation>`, so we skip it here. - -Download RQt Repositories -^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. code-block:: bash - - cd ~/ros2_ws - vcs import --force --input https://raw.githubusercontent.com/PickNikRobotics/rqt2_setup/master/rqt2.repos src - -As an alternative to the hosted ``.repos`` file you can use ``rosinstall_generator`` to generate a custom one: - -.. code-block:: bash - - rosinstall_generator --rosdistro crystal --upstream-development --repos python_qt_binding qt_gui_core rqt > rqt2.repos - vcs import --force src < rqt2.repos - -Install Dependencies -^^^^^^^^^^^^^^^^^^^^ - -.. toctree:: - :hidden: - - RQt-Source-Install-MacOS - RQt-Source-Install-Windows10 - -For non-Linux platforms, see the :doc:`macOS RQt source install page ` or the :doc:`Windows 10 RQt source install page ` before continuing here. - -.. code-block:: bash - - rosdep install --from-paths src --ignore-src --rosdistro bouncy -y --skip-keys "console_bridge fastcdr fastrtps rti-connext-dds-6.0.1 urdfdom_headers" - -Build The Workspace -^^^^^^^^^^^^^^^^^^^ - -Generally building a workspace is as simple as: - -.. code-block:: bash - - colcon build - -For Windows, it is recommended to use the ``--merge-install`` option. - -.. code-block:: bat - - colcon build --merge-install - -Advanced Colcon usages: - -- Show verbose output on the console: - - .. code-block:: bash - - colcon build –event-handlers console_direct+ - -- Only build one package and its dependencies: - - .. code-block:: bash - - colcon build –packages-up-to rqt_shell - -Source your environment -^^^^^^^^^^^^^^^^^^^^^^^ - -Linux or macOS - -.. code-block:: bash - - . install/local_setup.bash - -Windows - -.. code-block:: bat - - call install/local_setup.bat - - -Using RQt ----------- - -See :doc:`Overview of RQt <../Concepts/Intermediate/About-RQt>`.