Skip to content
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.

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

[21114] Check suprocess return codes on RDT generation (backport #795) #796

Merged
merged 5 commits into from
Jul 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion code/doxygen-config.in
Original file line number Diff line number Diff line change
Expand Up @@ -985,7 +985,7 @@ EXCLUDE_SYMBOLS =
# that contain example code fragments that are included (see the \include
# command).

EXAMPLE_PATH = @PROJECT_SOURCE_DIR@/code
EXAMPLE_PATH =

# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
Expand Down
38 changes: 15 additions & 23 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -216,22 +216,13 @@ def configure_doxyfile(
fastdds_branch = os.environ.get('FASTDDS_BRANCH', None)

# First try to checkout to ${FASTDDS_BRANCH}
# Else try with current documentation branch
# Else checkout to master
# Else checkout to 2.14.x
if (fastdds_branch and
fastdds.refs.__contains__('origin/{}'.format(fastdds_branch))):
fastdds_branch = 'origin/{}'.format(fastdds_branch)
elif (docs_branch and
fastdds.refs.__contains__('origin/{}'.format(docs_branch))):
fastdds_branch = 'origin/{}'.format(docs_branch)
else:
print(
'Fast DDS does not have either "{}" or "{}" branches'.format(
fastdds_branch,
docs_branch
)
)
fastdds_branch = 'origin/master'
fastdds_branch = 'origin/2.14.x'
print(f'Fast DDS branch is not set by env var. Using "{fastdds_branch}"')

# Actual checkout
print('Checking out Fast DDS branch "{}"'.format(fastdds_branch))
Expand All @@ -248,20 +239,14 @@ def configure_doxyfile(
fastdds_python_branch = os.environ.get('FASTDDS_PYTHON_BRANCH', None)

# First try to checkout to ${FASTDDS_PYTHON_BRANCH}
# Else try with current documentation branch
# Else checkout to master
# Else checkout to 1.4.x
if (fastdds_python_branch and
fastdds_python.refs.__contains__(
'origin/{}'.format(fastdds_python_branch))):
fastdds_python_branch = 'origin/{}'.format(fastdds_python_branch)
elif (docs_branch and
fastdds_python.refs.__contains__('origin/{}'.format(docs_branch))):
fastdds_python_branch = 'origin/{}'.format(docs_branch)
else:
print(
'Fast DDS Python does not have either "{}" or "{}" branches'
.format(fastdds_python_branch, docs_branch))
fastdds_python_branch = 'origin/main'
fastdds_python_branch = 'origin/1.4.x'
print(f'Fast DDS Python branch is not set by env var. Using "{fastdds_python_branch}"')

# Actual checkout
print('Checking out Fast DDS Python branch "{}"'.format(
Expand All @@ -285,10 +270,13 @@ def configure_doxyfile(
project_source_dir
)
# Generate doxygen documentation
subprocess.call('doxygen {}'.format(doxyfile_out), shell=True)
doxygen_ret = subprocess.call('doxygen {}'.format(doxyfile_out), shell=True)
if doxygen_ret != 0:
print('Doxygen failed with return code {}'.format(doxygen_ret))
sys.exit(doxygen_ret)

# Generate SWIG code.
subprocess.call('swig -python -doxygen -I{}/include \
swig_ret = subprocess.call('swig -python -doxygen -I{}/include \
-outdir {}/fastdds_python/src/swig -c++ -interface \
_fastdds_python -o \
{}/fastdds_python/src/swig/fastddsPYTHON_wrap.cxx \
Expand All @@ -298,6 +286,10 @@ def configure_doxyfile(
fastdds_python_repo_name,
fastdds_python_repo_name
), shell=True)
if swig_ret != 0:
print('SWIG failed with return code {}'.format(swig_ret))
sys.exit(swig_ret)

fastdds_python_imported_location = '{}/fastdds_python/src/swig'.format(
fastdds_python_repo_name)
autodoc_mock_imports = ["_fastdds_python"]
Expand Down
2 changes: 2 additions & 0 deletions docs/docutils.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[general]
halt_level: 2
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,4 @@ DomainParticipantQos
.. autoclass:: fastdds.DomainParticipantQos


.. TODO
.. autoclass:: fastdds.PARTICIPANT_QOS_DEFAULT
.. autodata:: fastdds.PARTICIPANT_QOS_DEFAULT
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ DataWriterQos

.. autoclass:: fastdds.DataWriterQos

.. autoclass:: fastdds.DATAWRITER_QOS_DEFAULT
.. autodata:: fastdds.DATAWRITER_QOS_DEFAULT

.. autoclass:: fastdds.DATAWRITER_QOS_USE_TOPIC_QOS
.. autodata:: fastdds.DATAWRITER_QOS_USE_TOPIC_QOS
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ PublisherQos

.. autoclass:: fastdds.PublisherQos

.. autoclass:: fastdds.PUBLISHER_QOS_DEFAULT
.. autodata:: fastdds.PUBLISHER_QOS_DEFAULT
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ DataReaderQos

.. autoclass:: fastdds.DataReaderQos

.. autoclass:: fastdds.DATAREADER_QOS_DEFAULT
.. autodata:: fastdds.DATAREADER_QOS_DEFAULT

.. autoclass:: fastdds.DATAREADER_QOS_USE_TOPIC_QOS
.. autodata:: fastdds.DATAREADER_QOS_USE_TOPIC_QOS
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ SubscriberQos

.. autoclass:: fastdds.SubscriberQos

.. autoclass:: fastdds.SUBSCRIBER_QOS_DEFAULT
.. autodata:: fastdds.SUBSCRIBER_QOS_DEFAULT
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ TopicQos

.. autoclass:: fastdds.TopicQos

.. autoclass:: fastdds.TOPIC_QOS_DEFAULT
.. autodata:: fastdds.TOPIC_QOS_DEFAULT
Loading