Skip to content

Fix minor error in documents #948

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Fix minor error in documents #948

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
220c752
Fix enumeration error in the README
Javgilavi Nov 12, 2024
9b8ee53
Add all possibilities available to XML example of DataSharingQosPolicy
Javgilavi Nov 12, 2024
33488b3
Fix error on XML code in 12.1.8 on the docs
Javgilavi Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ building tools.
colcon build
```

[^colcon_ignore]: If the virtual environment is placed within the colcon workspace, it is recommended to add an empty `COLCON_IGNORE` file in the root of the virtual environment so that colcon does not inspect it.
[^colcon_ignore]: If the virtual environment is placed within the colcon workspace, it is recommended to add an empty `COLCON_IGNORE` file in the root of the virtual environment so that colcon does not inspect it.

1. Run documentation tests:

Expand Down Expand Up @@ -172,7 +172,7 @@ cd <path_to_repo>/fastdds-docs/build
ctest -VV
```

### Simulating Read the Docs
### Simulating Read the Docs (optional)

ReadTheDocs generates the documentation using Sphinx and [conf.py](docs/conf.py).
This means that it does not execute any colcon or CMake commands.
Expand Down
4 changes: 3 additions & 1 deletion code/XMLTester.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,8 @@
<qos>
<data_sharing>
<kind>AUTOMATIC</kind>
<shared_dir>/home</shared_dir>
<max_domains>10</max_domains>
<domain_ids>
<domainId>123</domainId>
<domainId>098</domainId>
Expand Down Expand Up @@ -3265,7 +3267,7 @@
<properties>
<property>
<name>fastdds.type_propagation</name>
<value>enable</value>
<value>enabled</value>
</property>
</properties>
</propertiesPolicy>
Expand Down
2 changes: 1 addition & 1 deletion docs/fastdds/property_policies/non_consolidated_qos.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -509,4 +509,4 @@ The different property values have the following effects on the local |DomainPar
:language: xml
:start-after: <!-->TYPE_PROPAGATION_PROPERTY<-->
:end-before: <!--><-->
:lines: 2-4,6-16,18-19
:lines: 2-4,6-17,19-20