{"id":20099156,"url":"https://github.com/ros2/ros2_documentation","last_synced_at":"2025-05-14T05:12:03.776Z","repository":{"id":37238585,"uuid":"148210342","full_name":"ros2/ros2_documentation","owner":"ros2","description":"ROS 2 docs repository","archived":false,"fork":false,"pushed_at":"2025-05-11T19:06:24.000Z","size":48977,"stargazers_count":654,"open_issues_count":161,"forks_count":1136,"subscribers_count":44,"default_branch":"rolling","last_synced_at":"2025-05-11T20:18:19.953Z","etag":null,"topics":["hacktoberfest","ros"],"latest_commit_sha":null,"homepage":"https://docs.ros.org/en/rolling","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ros2.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-09-10T19:49:17.000Z","updated_at":"2025-05-11T19:00:08.000Z","dependencies_parsed_at":"2022-08-08T19:30:49.578Z","dependency_job_id":"8d95fc45-99ae-42c9-a6cd-bb1a5ab434f1","html_url":"https://github.com/ros2/ros2_documentation","commit_stats":{"total_commits":1847,"total_committers":331,"mean_commits":5.580060422960725,"dds":0.8267460747157553,"last_synced_commit":"994c0d9173e30d541557b14e0b2bf5e7d84c33ba"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ros2%2Fros2_documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ros2%2Fros2_documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ros2%2Fros2_documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ros2%2Fros2_documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ros2","download_url":"https://codeload.github.com/ros2/ros2_documentation/tar.gz/refs/heads/rolling","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254076850,"owners_count":22010611,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","ros"],"created_at":"2024-11-13T17:08:32.903Z","updated_at":"2025-05-14T05:11:58.763Z","avatar_url":"https://github.com/ros2.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ROS 2 Documentation\n\nThis repository contains the sources for the ROS 2 documentation that is hosted at [https://docs.ros.org/en](https://docs.ros.org/en).\nThe sources from this repository are built and uploaded to the site nightly by a [Jenkins job](https://build.ros.org/job/doc_ros2doc).\n\n## Contributing to the documentation\n\nContributions to this site are most welcome.\nPlease 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.\n\n## Contributing to ROS 2\n\nTo 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).\n\n## Prerequisites\n\nTo build this you need to install\n\n* make\n* graphviz\n\nWith [venv](https://docs.python.org/3/library/venv.html)\n\n```\n# activate the venv\npython3 -m venv ros2doc\n\n# activate venv\nsource ros2doc/bin/activate\n\n# install required packages\npip install -r requirements.txt -c constraints.txt\n\n# deactivate the venv\n(ros2doc) deactivate\n```\n\n### Pinned versions\n\nFor development we currently use Noble as our build platform.\nAnd all python versions are pinned in the constraints file to make sure that things are reproducible.\nTo upgrade the system validate that things are working and then use `pip freeze \u003e constraints.txt` to lock in the versions to upgrade.\n\n## Building HTML\n\n### Local development test\n\nFor local testing of the current tree use:\n\n`make html`\n\n`sensible-browser build/html/index.html`\n\n### Spelling Check\n\nTo check the spelling, use:\n\n`make spellcheck`\n\n\u003e [!NOTE]\n\u003e If that detects specific words that need to be ignored, add it to [codespell_whitelist](./codespell_whitelist.txt). \\\n\u003e To include any custom corrections that are to be applied, add it to [codespell_dictionary](./codespell_dictionary.txt).\n\n### Deployment test\n\nTo test building the multisite version deployed to the website use:\n\n`make multiversion`\n\n`sensible-browser build/html/rolling/index.html`\n\n**NB:** This will ignore local workspace changes and build from the branches.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fros2%2Fros2_documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fros2%2Fros2_documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fros2%2Fros2_documentation/lists"}