sphinx_ros
This extension adds reStructuredText directives that can be used to document ROS packages.
Usage
Include the extension in your conf.py file. If you have no extensions yet, use:
extensions = ['sphinx_ros']
Otherwise use:
extensions.append('sphinx_ros')
This adds the ros domain to Sphinx, and allows you to use the directives defined in this extension, e.g. .. ros:package::, .. ros:message:: et cetera.
A minimal example:
.. ros:package:: foo_bar_package .. ros:message:: foo :msg_param bar: The bar included in foo. :msg_paramtype bar: :ros:msg:`int16`
See the docs for more information.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-ros 0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx-ros-0.1.tar.gz | 7.4 MB | Details |
Built distributions (wheels)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_ros-0.1.0-py2-none-any.whl | Python 2 | none | any | Details |
| sphinx_ros-0.1-py2-none-any.whl | Python 2 | none | any | Details |
Total release size: 7.4 MB
Release files / sphinx-ros-0.1.tar.gz
| Download URL | sphinx-ros-0.1.tar.gz |
|---|---|
| Size | 7.4 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4be138603fdb922a7cee2bf3c7c97556dd5de7d7138097719cf2eccdc126edaa
|
|
BLAKE2b-256 checksum How to use checksums |
c2ee2b2a0452e2a5cdddc32be3bb83e228ca9898e5a25ec208eca63b83a57f40
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/2.7.12
|
Release files / sphinx_ros-0.1.0-py2-none-any.whl
| Download URL | sphinx_ros-0.1.0-py2-none-any.whl |
|---|---|
| Size | 10.8 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
37a8f689efeb2a39403320b8507be1881bb56f8a4ecee858d55b048656e713fb
|
|
BLAKE2b-256 checksum How to use checksums |
84c5d67f93868fa1ced2ba6a2e89048b44f1ff4a05f1714d8164a7e764b369f3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/2.7.12
|
Release files / sphinx_ros-0.1-py2-none-any.whl
| Download URL | sphinx_ros-0.1-py2-none-any.whl |
|---|---|
| Size | 10.8 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
7d29657f8ff9b68d27f0ba9417bab1bf49a391819e21c8643d4e39fa19105843
|
|
BLAKE2b-256 checksum How to use checksums |
7426428ad9eb0f9a0025b37ae2d06eeacd3f86bdb9111d7a86243f7f3f831507
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/2.7.12
|
