Skip to content

Commit 14fe343

Browse files
Update README.md
Signed-off-by: Nils-Christian Iseke <48475933+Nils-ChristianIseke@users.noreply.github.com>
1 parent 79acc6d commit 14fe343

File tree

1 file changed

+1
-60
lines changed

1 file changed

+1
-60
lines changed

README.md

Lines changed: 1 addition & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -6,67 +6,8 @@ The sources from this repository are built and uploaded to the site nightly by a
66
## Contributing to the documentation
77

88
Contributions to this site are most welcome.
9-
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.
9+
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 contribute.
1010

1111
## Contributing to ROS 2
1212

1313
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).
14-
15-
## Prerequisites
16-
17-
To build this you need to install
18-
19-
* make
20-
* graphviz
21-
22-
With [venv](https://docs.python.org/3/library/venv.html)
23-
24-
```
25-
# activate the venv
26-
python3 -m venv ros2doc
27-
28-
# activate venv
29-
source ros2doc/bin/activate
30-
31-
# install required packages
32-
pip install -r requirements.txt -c constraints.txt
33-
34-
# deactivate the venv
35-
(ros2doc) deactivate
36-
```
37-
38-
### Pinned versions
39-
40-
For development we currently use Noble as our build platform.
41-
And all python versions are pinned in the constraints file to make sure that things are reproducible.
42-
To upgrade the system validate that things are working and then use `pip freeze > constraints.txt` to lock in the versions to upgrade.
43-
44-
## Building HTML
45-
46-
### Local development test
47-
48-
For local testing of the current tree use:
49-
50-
`make html`
51-
52-
`sensible-browser build/html/index.html`
53-
54-
### Spelling Check
55-
56-
To check the spelling, use:
57-
58-
`make spellcheck`
59-
60-
> [!NOTE]
61-
> If that detects specific words that need to be ignored, add it to [codespell_whitelist](./codespell_whitelist.txt). \
62-
> To include any custom corrections that are to be applied, add it to [codespell_dictionary](./codespell_dictionary.txt).
63-
64-
### Deployment test
65-
66-
To test building the multisite version deployed to the website use:
67-
68-
`make multiversion`
69-
70-
`sensible-browser build/html/rolling/index.html`
71-
72-
**NB:** This will ignore local workspace changes and build from the branches.

0 commit comments

Comments
 (0)