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

Fix external docs mappings #757

Open
wants to merge 6 commits into
base: rolling
Choose a base branch
from

Conversation

EmmanuelMess
Copy link

Related to #756

@EmmanuelMess
Copy link
Author

I haven't tested any of this, lets hope it works.

@christophebedard
Copy link
Member

It would be great if you could test it and see how it affects the output for each package. Building and running isn't too complicated.

@EmmanuelMess
Copy link
Author

EmmanuelMess commented Feb 5, 2025

The changes work, but there are warnings for tf2_ros now:

rosdoc2 build --package-path ./tf2_ros
[rosdoc2] [WARNING] rosdoc2.yaml contains enable_breathe or enable_exhale, which are not valid. If false, these will be interpreted to mean "never_run_doxygen=true". This conversion is DEPRECATED and may be removed after 2025.
[rosdoc2] [INFO] The package has never_run_doxygen set, so skipping doxygen.
[rosdoc2] [INFO] Note: the builder 'tf2_ros C++ API (doxygen)' did not generate any output to be copied into the destination.
[rosdoc2] [INFO] No doxygen_xml_directory found, apparently doxygen did not run
[rosdoc2] [WARNING] python_source specified as tf2_ros is not a directory
[rosdoc2] [INFO] interface_counts: {'msg': 0, 'srv': 0, 'action': 0}
[rosdoc2] [INFO] standard_docs: {'package': {'path': './tf2_ros/package.xml', 'filename': 'package.xml', 'type': 'xml'}, 'changelog': {'path': './tf2_ros/CHANGELOG.rst', 'filename': 'CHANGELOG.rst', 'type': 'rst'}}
[rosdoc2] [INFO] Note: no user_doc_dir provided, but a doc directory was located in a standard location "doc" and that will be used.
[rosdoc2] [INFO] include_user_docs: sphinx_project_directory <doc> output_dir </home/emmanuelm/Documentos/GitHub/geometry2/docs_build/tf2_ros/tf2_ros-python-api/wrapped_sphinx_directory>
[rosdoc2] [INFO] Documentation found in directories ['.']
[rosdoc2] [INFO] Copying ./tf2_ros/doc to /home/emmanuelm/Documentos/GitHub/geometry2/docs_build/tf2_ros/tf2_ros-python-api/wrapped_sphinx_directory/doc
[rosdoc2] [INFO] doc_directories: ['.']
[rosdoc2] [INFO] Not searching for package repository url because ROS_DISTRO is not set
[rosdoc2] [INFO] Using a default index.rst.jinja
[rosdoc2] [INFO] Running Sphinx-build: 'sphinx-build /home/emmanuelm/Documentos/GitHub/geometry2/docs_build/tf2_ros/tf2_ros-python-api/wrapped_sphinx_directory /home/emmanuelm/Documentos/GitHub/geometry2/docs_build/tf2_ros/tf2_ros-python-api/wrapped_sphinx_directory/sphinx_output' in '/home/emmanuelm/Documentos/GitHub/geometry2/docs_build/tf2_ros/tf2_ros-python-api/wrapped_sphinx_directory'
Ejecutando Sphinx v8.1.3
[rosdoc2] user conf.py specified allowed extensions: ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', 'sphinx.ext.githubpages']
[rosdoc2] enabling autodoc
[rosdoc2] enabling intersphinx
[rosdoc2] overriding theme to be 'sphinx_rtd_theme'
[rosdoc2] extending intersphinx mapping
[rosdoc2] adding markdown parser
cargando traducciones [en]... hecho
Converting `source_suffix = '.rst'` to `source_suffix = {'.rst': 'restructuredtext'}`.
loading intersphinx inventory 'python' from http://docs.python.org/3/objects.inv ...
loading intersphinx inventory 'opencv' from http://docs.opencv.org/3.0-last-rst/objects.inv ...
loading intersphinx inventory 'numpy' from http://docs.scipy.org/doc/numpy/objects.inv ...
el inventario intersphinx se ha movido: http://docs.python.org/3/objects.inv -> https://docs.python.org/3/objects.inv
el inventario intersphinx se ha movido: http://docs.opencv.org/3.0-last-rst/objects.inv -> https://docs.opencv.org/3.0-last-rst/objects.inv
el inventario intersphinx se ha movido: http://docs.scipy.org/doc/numpy/objects.inv -> https://numpy.org/doc/stable/objects.inv
myst v4.0.0: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions=set(), disable_syntax=[], all_links_external=False, links_external_new_tab=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={}, footnote_sort=True, footnote_transition=True, words_per_minute=200, substitutions={}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
compilando [mo]: los objetivos para 0 los archivos po que estan desactualizados
escribiendo salida... 
compilando [html]: los objetivos para 9 los archivos fuentes que estan desactualizados
actualizando ambiente: [nueva configuración] 9añadido, 0 cambiado, 0 removido
leyendo fuentes... [100%] user_docs
/home/emmanuelm/Documentos/GitHub/geometry2/docs_build/tf2_ros/tf2_ros-python-api/wrapped_sphinx_directory/doc/index.rst:65: WARNING: toctree contiene referencias a documentos inexistentes 'doc/generated/index' [toc.not_readable]
/home/emmanuelm/Documentos/GitHub/geometry2/docs_build/tf2_ros/tf2_ros-python-api/wrapped_sphinx_directory/doc/index.rst:65: WARNING: toctree contiene referencias a documentos inexistentes 'doc/modules' [toc.not_readable]
WARNING: autodoc: failed to import exception 'buffer_interface.TypeException' from module 'tf2_ros'; the following exception was raised:
No module named 'tf2_ros' [autodoc.import_object]
WARNING: autodoc: failed to import exception 'buffer_interface.NotImplementedException' from module 'tf2_ros'; the following exception was raised:
No module named 'tf2_ros' [autodoc.import_object]
WARNING: autodoc: failed to import class 'buffer_interface.BufferInterface' from module 'tf2_ros'; the following exception was raised:
No module named 'tf2_ros' [autodoc.import_object]
WARNING: autodoc: failed to import class 'buffer.Buffer' from module 'tf2_ros'; the following exception was raised:
No module named 'tf2_ros' [autodoc.import_object]
WARNING: autodoc: failed to import class 'buffer_client.BufferClient' from module 'tf2_ros'; the following exception was raised:
No module named 'tf2_ros' [autodoc.import_object]
WARNING: autodoc: failed to import class 'transform_broadcaster.TransformBroadcaster' from module 'tf2_ros'; the following exception was raised:
No module named 'tf2_ros' [autodoc.import_object]
WARNING: autodoc: failed to import class 'transform_listener.TransformListener' from module 'tf2_ros'; the following exception was raised:
No module named 'tf2_ros' [autodoc.import_object]
buscando por archivos no actualizados... no encontrado
preparando ambiente... hecho
verificando consistencia... /home/emmanuelm/Documentos/GitHub/geometry2/docs_build/tf2_ros/tf2_ros-python-api/wrapped_sphinx_directory/doc/cli_tools.rst: document is referenced in multiple toctrees: ['doc/index', 'user_docs'], selecting: user_docs <- doc/cli_tools
/home/emmanuelm/Documentos/GitHub/geometry2/docs_build/tf2_ros/tf2_ros-python-api/wrapped_sphinx_directory/doc/tf2_ros2.rst: document is referenced in multiple toctrees: ['doc/index', 'user_docs'], selecting: user_docs <- doc/tf2_ros2
hecho
preparando documentos... hecho
copying assets... 
copiar archivos estáticos... 
Writing evaluated template result to /home/emmanuelm/Documentos/GitHub/geometry2/docs_build/tf2_ros/tf2_ros-python-api/wrapped_sphinx_directory/sphinx_output/_static/language_data.js
Writing evaluated template result to /home/emmanuelm/Documentos/GitHub/geometry2/docs_build/tf2_ros/tf2_ros-python-api/wrapped_sphinx_directory/sphinx_output/_static/basic.css
Writing evaluated template result to /home/emmanuelm/Documentos/GitHub/geometry2/docs_build/tf2_ros/tf2_ros-python-api/wrapped_sphinx_directory/sphinx_output/_static/documentation_options.js
Writing evaluated template result to /home/emmanuelm/Documentos/GitHub/geometry2/docs_build/tf2_ros/tf2_ros-python-api/wrapped_sphinx_directory/sphinx_output/_static/js/versions.js
copiar archivos estáticos: hecho
copiando archivos extras... 
copiando archivos extras: hecho
copying assets: hecho
escribiendo salida... [100%] user_docs
/home/emmanuelm/Documentos/GitHub/geometry2/docs_build/tf2_ros/tf2_ros-python-api/wrapped_sphinx_directory/doc/index.rst:8: WARNING: etiqueta indefinida: 'exhale_class_classtf2__ros_1_1transformbroadcaster' [ref.ref]
/home/emmanuelm/Documentos/GitHub/geometry2/docs_build/tf2_ros/tf2_ros-python-api/wrapped_sphinx_directory/doc/index.rst:14: WARNING: etiqueta indefinida: 'exhale_class_classtf2__ros_1_1statictransformbroadcaster' [ref.ref]
/home/emmanuelm/Documentos/GitHub/geometry2/docs_build/tf2_ros/tf2_ros-python-api/wrapped_sphinx_directory/doc/index.rst:20: WARNING: etiqueta indefinida: 'exhale_class_classtf2__ros_1_1buffer' [ref.ref]
/home/emmanuelm/Documentos/GitHub/geometry2/docs_build/tf2_ros/tf2_ros-python-api/wrapped_sphinx_directory/doc/index.rst:20: WARNING: etiqueta indefinida: 'exhale_class_classtf2__ros_1_1bufferinterface' [ref.ref]
/home/emmanuelm/Documentos/GitHub/geometry2/docs_build/tf2_ros/tf2_ros-python-api/wrapped_sphinx_directory/doc/index.rst:20: WARNING: etiqueta indefinida: 'exhale_class_classtf2__ros_1_1transformlistener' [ref.ref]
/home/emmanuelm/Documentos/GitHub/geometry2/docs_build/tf2_ros/tf2_ros-python-api/wrapped_sphinx_directory/doc/index.rst:32: WARNING: etiqueta indefinida: 'exhale_class_classtf2__ros_1_1messagefilter' [ref.ref]
generando índices... genindex hecho
resaltando el código del módulo... 
escribiendo páginas adicionales... search hecho
copiando imágenes... [100%] doc/images/rqt_tf_tree.png
volcar el índice de búsqueda en English (code: en)... hecho
volcar inventario de objetos... hecho
build succeeded, 15 warnings.

Las páginas HTML están en sphinx_output.
[rosdoc2] [INFO] Sphinx-build exited with return code '0'
[rosdoc2] [INFO] Moving inventory file '/home/emmanuelm/Documentos/GitHub/geometry2/docs_build/tf2_ros/tf2_ros-python-api/wrapped_sphinx_directory/sphinx_output/objects.inv' into cross-reference directory 'cross_reference/tf2_ros/objects.inv'
[rosdoc2] [INFO] Moving files for 'tf2_ros Python API (sphinx)' from '/home/emmanuelm/Documentos/GitHub/geometry2/docs_build/tf2_ros/tf2_ros-python-api/wrapped_sphinx_directory/sphinx_output' into 'docs_build/tf2_ros/output_staging/'.
[rosdoc2] [INFO] Moved 86 files.
[rosdoc2] [INFO] Moving files to final destination in 'docs_output/tf2_ros'.

@EmmanuelMess EmmanuelMess force-pushed the emmanuelmess/fix/python_mapping branch from d9ad6a0 to 701e825 Compare February 5, 2025 22:37
Comment on lines +55 to +56
project = u'tf2_ros'
copyright = u'2025, Open Source Robotics Foundation' # noqa(A001)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changing the project name makes sense, but a bunch of files still have the Willow Garage copyright notice, so I would leave that as-is.

@christophebedard
Copy link
Member

The No module named 'tf2_ros' [autodoc.import_object] warnings look similar to ros2/launch_ros#424, but I think it's fine if it doesn't fully work yet. Incremental improvements are still good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants