diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml index 6310ce9..ec617dc 100644 --- a/.github/workflows/sphinx.yml +++ b/.github/workflows/sphinx.yml @@ -1,6 +1,10 @@ --- name: "Pull Request Docs Check" -on: [pull_request] +on: + pull_request: + push: + branches: + - main jobs: docs: @@ -10,13 +14,13 @@ jobs: uses: actions/checkout@v4 - uses: actions/setup-python@v5 with: - python-version: '3.10' + python-version: '3.12' cache: 'pip' - name: Install Python dependencies run: | python -m pip install --upgrade pip - pip install --upgrade --requirement ur_documentation/requirements.txt + pip install --upgrade --requirement requirements.txt shell: bash - name: Build documentation using sphinx run: | - TZ=UTC sphinx-build ur_documentation/docs/source _build + TZ=UTC sphinx-build --fail-on-warning --keep-going . _build diff --git a/conf.py b/conf.py new file mode 100644 index 0000000..b553922 --- /dev/null +++ b/conf.py @@ -0,0 +1,216 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = "Universal Robots ROS 2 Tutorials" +copyright = "2024, Universal Robots A/S" +author = "Felix Exner" + +# The short X.Y version +version = "" +# The full version, including alpha/beta/rc tags +release = "0.1" + + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx_copybutton", + "sphinx.ext.githubpages", + "sphinx.ext.todo", + "sphinx_rtd_theme", +] + +# Add any paths that contain templates here, relative to this directory. +# templates_path = ["_templates"] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +source_suffix = ".rst" + +# The master toctree document. +master_doc = "tutorial_index" +numfig = True + +ros_distro = "rolling" +distro_title = "Rolling" +distro_title_full = "Rolling Ridley" +repos_file_branch = "main" + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = "en" + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [ + "_build", + "Thumbs.db", + ".DS_Store", + "**/CHANGELOG.rst", + "**/README.rst", + "**/.work", # act temp files + "**/LICENSE.rst", + "venv", # local virtualenv +] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = None + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = "sphinx_rtd_theme" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +# html_static_path = ["_static"] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = "ur_documentationdoc" + + +# -- Options for LaTeX output ------------------------------------------------ + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ( + master_doc, + "ur_tutorials.tex", + "ur\\_tutorials Documentation", + "Felix Exner", + "manual", + ), +] + + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [(master_doc, "ur_tutorials", "ur_tutorials Documentation", [author], 1)] + + +# -- Options for Texinfo output ---------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + master_doc, + "ur_tutorials", + "ur_tutorials Documentation", + author, + "ur_tutorials", + "Tutorials around Universal Robot's ROS 2 packages", + "ROS 2", + ), +] + + +# -- Options for Epub output ------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# +# epub_identifier = '' + +# A unique identification for the text. +# +# epub_uid = '' + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ["search.html"] + + +# -- Extension configuration ------------------------------------------------- +copybutton_exclude = ".linenos, .gp, .go" + +# -- Options for todo extension ---------------------------------------------- + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + +html_context = { + "display_github": True, + "github_user": "UniversalRobots", + "github_repo": "Universal_Robots_ROS2_Tutorials", + "github_version": repos_file_branch + "/", + "conf_py_path": "/", + "source_suffix": source_suffix, +} + +github_url = "https://github.com/UniversalRobots/Universal_Robots_ROS2_Tutorials" diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..d014eb7 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +sphinx +sphinx_rtd_theme +sphinx-copybutton diff --git a/doc/tutorial_index.rst b/tutorial_index.rst similarity index 87% rename from doc/tutorial_index.rst rename to tutorial_index.rst index 6bbcb2f..851e9a1 100644 --- a/doc/tutorial_index.rst +++ b/tutorial_index.rst @@ -11,4 +11,4 @@ Example tutorials .. toctree:: :titlesonly: - ../my_robot_cell/doc/index.rst + my_robot_cell/doc/index.rst