adds first version

Author: louislelay

.github/workflows/docs.yaml

@@ -0,0 +1,29 @@
+name: Build and Deploy Sphinx Docs
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+
+      - name: Install dev requirements
+        working-directory: ./docs
+        run: pip install -r requirements.txt
+
+      - name: Build Sphinx Documentation
+        run: sphinx-build docs docs/_build
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/_build/

.gitignore

@@ -0,0 +1,3 @@
+# Doc Outputs
+**/docs/_build/*
+**/generated/*

.nojekyll

@@ -0,0 +1 @@
+# BDX-R Project Documentation

README.md

@@ -0,0 +1,67 @@
+#!/bin/bash
+set -e  # Exit on error
+set -u  # Treat unset variables as errors
+
+# Get source directory
+export BDX_R_DOC_PATH="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+
+# Extract the Python executable
+extract_python_exe() {
+    local python_exe=""
+
+    # Check if using Conda
+    if [[ -n "${CONDA_PREFIX:-}" ]]; then
+        python_exe="${CONDA_PREFIX}/bin/python"
+    fi
+
+    # Fallback to system Python if Conda Python not found
+    if [[ -z "${python_exe}" || ! -f "${python_exe}" ]]; then
+        if command -v python3 &> /dev/null; then
+            python_exe="$(which python3)"
+        elif command -v python &> /dev/null; then
+            python_exe="$(which python)"
+        fi
+    fi
+
+    # Ensure a valid Python executable is found
+    if [[ -z "${python_exe}" || ! -f "${python_exe}" ]]; then
+        echo -e "[ERROR] Unable to find a valid Python executable." >&2
+        echo -e "\tPossible reasons:\n\t1. Conda environment is not activated.\n\t2. Python is not installed.\n\t3. Only 'python3' is available but not 'python'." >&2
+        exit 1
+    fi
+
+    # Return the result
+    echo "${python_exe}"
+}
+
+echo "[INFO] Building documentation..."
+
+# Retrieve the Python executable
+python_exe=$(extract_python_exe)
+echo "${python_exe}"
+
+# # Ensure documentation directory exists
+if [ ! -d "${BDX_R_DOC_PATH}/docs" ]; then
+    echo "[ERROR] Documentation directory not found: ${BDX_R_DOC_PATH}/docs" >&2
+    exit 1
+fi
+
+# # Install pip packages
+cd "${BDX_R_DOC_PATH}/docs"
+${python_exe} -m pip install -r requirements.txt > /dev/null
+
+# # Build the documentation
+${python_exe} -m sphinx -b html -d _build/doctrees . _build/current
+
+# # Open the documentation in the default browser
+echo -e "[INFO] To open documentation, run:"
+echo -e "\n\t\txdg-open $(pwd)/_build/current/index.html\n"
+
+if [[ "$OSTYPE" == "darwin"* ]]; then
+    open "$(pwd)/_build/current/index.html"
+else
+    xdg-open "$(pwd)/_build/current/index.html"
+fi
+
+# # Exit neatly
+cd - > /dev/null

bdx_r.sh

@@ -0,0 +1,13 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+.PHONY: current-docs
+current-docs:
+	@$(SPHINXBUILD) "$(SOURCEDIR)" "$(BUILDDIR)/current" $(SPHINXOPTS)

docs/Makefile

@@ -0,0 +1,225 @@
+# Copyright (c) 2022-2025, The Isaac Lab Project Developers.
+# All rights reserved.
+#
+# SPDX-License-Identifier: BSD-3-Clause
+
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- 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
+
+
+# -- Project information -----------------------------------------------------
+
+project = "BDX-R Project Documentation"
+copyright = "2025, BDX-R Project Developers"
+author = "BDX-R Project Developers"
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "autodocsumm",
+    "myst_parser",
+    "sphinx.ext.napoleon",
+    "sphinxemoji.sphinxemoji",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.githubpages",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.todo",
+    "sphinx.ext.viewcode",
+    "sphinxcontrib.bibtex",
+    "sphinxcontrib.icon",
+    "sphinx_copybutton",
+    "sphinx_design",
+    "sphinx_tabs.tabs",  # backwards compatibility for building docs on v1.0.0
+    "sphinx_multiversion",
+]
+
+# mathjax hacks
+mathjax3_config = {
+    "tex": {
+        "inlineMath": [["\\(", "\\)"]],
+        "displayMath": [["\\[", "\\]"]],
+    },
+}
+
+# panels hacks
+panels_add_bootstrap_css = False
+panels_add_fontawesome_css = True
+
+# supported file extensions for source files
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".md": "markdown",
+}
+
+# make sure we don't have any unknown references
+# TODO: Enable this by default once we have fixed all the warnings
+# nitpicky = True
+
+# put type hints inside the signature instead of the description (easier to maintain)
+autodoc_typehints = "signature"
+# autodoc_typehints_format = "fully-qualified"
+# document class *and* __init__ methods
+autoclass_content = "class"  #
+# separate class docstring from __init__ docstring
+autodoc_class_signature = "separated"
+# sort members by source order
+autodoc_member_order = "bysource"
+# inherit docstrings from base classes
+autodoc_inherit_docstrings = True
+# BibTeX configuration
+bibtex_bibfiles = ["source/_static/refs.bib"]
+# generate autosummary even if no references
+autosummary_generate = True
+autosummary_generate_overwrite = False
+# default autodoc settings
+autodoc_default_options = {
+    "autosummary": True,
+}
+
+# generate links to the documentation of objects in external projects
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+}
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = []
+
+# 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", "_redirect", "_templates", "Thumbs.db", ".DS_Store", "README.md", "licenses/*"]
+
+# Mock out modules that are not available on RTD
+autodoc_mock_imports = [
+    "torch",
+    "numpy",
+    "matplotlib",
+    "scipy",
+    "carb",
+    "warp",
+    "pxr",
+    "h5py",
+    "hid",
+    "prettytable",
+    "tqdm",
+    "tensordict",
+    "trimesh",
+    "toml",
+]
+
+# List of zero or more Sphinx-specific warning categories to be squelched (i.e.,
+# suppressed, ignored).
+suppress_warnings = [
+    # Generally speaking, we do want Sphinx to inform
+    # us about cross-referencing failures. Remove this entirely after Sphinx
+    # resolves this open issue:
+    #   https://github.com/sphinx-doc/sphinx/issues/4961
+    # Squelch mostly ignorable warnings resembling:
+    #     WARNING: more than one target found for cross-reference 'TypeHint':
+    #     beartype.door._doorcls.TypeHint, beartype.door.TypeHint
+    #
+    # Sphinx currently emits *MANY* of these warnings against our
+    # documentation. All of these warnings appear to be ignorable. Although we
+    # could explicitly squelch *SOME* of these warnings by canonicalizing
+    # relative to absolute references in docstrings, Sphinx emits still others
+    # of these warnings when parsing PEP-compliant type hints via static
+    # analysis. Since those hints are actual hints that *CANNOT* by definition
+    # by canonicalized, our only recourse is to squelch warnings altogether.
+    "ref.python",
+]
+
+# -- Internationalization ----------------------------------------------------
+
+# specifying the natural language populates some key tags
+language = "en"
+
+# -- Options for HTML output -------------------------------------------------
+
+import sphinx_book_theme
+
+html_title = "BDX-R Project Documentation"
+html_theme_path = [sphinx_book_theme.get_html_theme_path()]
+html_theme = "sphinx_book_theme"
+html_favicon = "source/_static/favicon.ico"
+html_show_copyright = True
+html_show_sphinx = False
+html_last_updated_fmt = ""  # to reveal the build date in the pages meta
+
+# 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 = ["source/_static/css"]
+html_css_files = ["custom.css"]
+
+html_theme_options = {
+    "collapse_navigation": True,
+    "repository_url": "https://github.com/BDX-R/BDX-R.github.io",
+    "use_repository_button": True,
+    "use_issues_button": True,
+    "use_edit_page_button": True,
+    "show_toc_level": 1,
+    "use_sidenotes": True,
+    "logo": {
+        "text": "BDX-R Project Documentation",
+        "image_light": "source/_static/bdx_r_bg.png",
+        "image_dark": "source/_static/bdx_r_bg.png",
+    },
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/BDX-R/BDX-R.github.io",
+            "icon": "fa-brands fa-square-github",
+            "type": "fontawesome",
+        },
+    ],
+    "icon_links_label": "Quick Links",
+}
+
+templates_path = [
+    "_templates",
+]
+
+# Whitelist pattern for remotes
+smv_remote_whitelist = r"^.*$"
+# Whitelist pattern for branches (set to None to ignore all branches)
+smv_branch_whitelist = os.getenv("SMV_BRANCH_WHITELIST", r"^(main|devel)$")
+# Whitelist pattern for tags (set to None to ignore all tags)Add commentMore actions
+smv_tag_whitelist = os.getenv("SMV_TAG_WHITELIST", r"^v[1-9]\d*\.\d+\.\d+$")
+# html_sidebars = {
+#     "**": ["navbar-logo.html", "versioning.html", "icon-links.html", "search-field.html", "sbt-sidebar-nav.html"]
+# }
+
+html_sidebars = {
+    "**": ["navbar-logo.html", "icon-links.html", "search-field.html", "sbt-sidebar-nav.html"]
+}
+
+
+# -- Advanced configuration -------------------------------------------------
+
+
+def skip_member(app, what, name, obj, skip, options):
+    # List the names of the functions you want to skip here
+    exclusions = ["from_dict", "to_dict", "replace", "copy", "validate", "__post_init__"]
+    if name in exclusions:
+        return True
+    return None
+
+
+def setup(app):
+    app.connect("autodoc-skip-member", skip_member)