diff --git a/README.md b/README.md index 3dffb339573..18772ab624f 100644 --- a/README.md +++ b/README.md @@ -6,67 +6,8 @@ The sources from this repository are built and uploaded to the site nightly by a ## Contributing to the documentation Contributions to this site are most welcome. -Please see the [Contributing to ROS 2 Documentation](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.html) page to learn more. +Please see the [Contributing to ROS 2 Documentation](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.html) page to learn how to build and contribute. ## Contributing to ROS 2 To contribute to the ROS 2 source code project please refer to the [ROS 2 contributing guidelines](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing.html). - -## Prerequisites - -To build this you need to install - -* make -* graphviz - -With [venv](https://docs.python.org/3/library/venv.html) - -``` -# activate the venv -python3 -m venv ros2doc - -# activate venv -source ros2doc/bin/activate - -# install required packages -pip install -r requirements.txt -c constraints.txt - -# deactivate the venv -(ros2doc) deactivate -``` - -### Pinned versions - -For development we currently use Jammy (Ubuntu 22.04) as our build platform. -And all python versions are pinned in the constraints file to make sure that things are reproducible. -To upgrade the system validate that things are working and then use `pip freeze > constraints.txt` to lock in the versions to upgrade. - -## Building HTML - -### Local development test - -For local testing of the current tree use: - -`make html` - -`sensible-browser build/html/index.html` - -### Spelling Check - -To check the spelling, use: - -`make spellcheck` - -> [!NOTE] -> If that detects specific words that need to be ignored, add it to [codespell_whitelist](./codespell_whitelist.txt). \ -> To include any custom corrections that are to be applied, add it to [codespell_dictionary](./codespell_dictionary.txt). - -### Deployment test - -To test building the multisite version deployed to the website use: - -`make multiversion` - -`sensible-browser build/html/rolling/index.html` - -**NB:** This will ignore local workspace changes and build from the branches. diff --git a/source/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.rst b/source/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.rst index 397285bdfe1..34dfef7ac52 100644 --- a/source/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.rst +++ b/source/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.rst @@ -83,6 +83,14 @@ In order for Sphinx to be able to generate diagrams, the ``dot`` command must be Download an installer from `the Graphviz Download page `__ and install it. Make sure to allow the installer to add it to the Windows ``%PATH%``, otherwise Sphinx will not be able to find it. +Pinned versions +^^^^^^^^^^^^^^^ + +For development we currently use Jammy (Ubuntu 22.04) as our build platform. +And all python versions are pinned in the constraints file to make sure that things are reproducible. +To upgrade the system validate that things are working and then use `pip freeze > constraints.txt` to lock in the versions to upgrade. + + Building the site for one branch ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^