Skip to content

Commit 5024b20

Browse files
uzukuHanqingWangAI
uzuku
and
HanqingWangAI
committed
[docs] Initial commit
Co-authored-by: hanqing <409082492@qq.com>
0 parents  commit 5024b20

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+2658
-0
lines changed

‎.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.vscode
2+
.idea
3+
.DS_Store
4+
5+
_build

‎.pre-commit-config.yaml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
repos:
2+
- repo: https://github.com/codespell-project/codespell
3+
rev: v2.2.1
4+
hooks:
5+
- id: codespell
6+
- repo: https://github.com/gitleaks/gitleaks
7+
rev: v8.24.0
8+
hooks:
9+
- id: gitleaks
10+
- repo: https://github.com/pre-commit/pre-commit-hooks
11+
rev: v3.1.0
12+
hooks:
13+
- id: trailing-whitespace
14+
- id: check-yaml
15+
- id: end-of-file-fixer
16+
- id: requirements-txt-fixer
17+
- id: double-quote-string-fixer
18+
- id: check-merge-conflict
19+
- id: fix-encoding-pragma
20+
args: ["--remove"]
21+
- id: mixed-line-ending
22+
args: ["--fix=lf"]

‎Makefile‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = ./source/en
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎README.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Documentation (English Version)
2+
3+
1. Install Sphinx and other dependencies.
4+
5+
```bash
6+
pip install -r requirements.txt
7+
```
8+
9+
2. Build the documentation and watch the change lively
10+
11+
```bash
12+
rm -rf _build/; make html;
13+
```

‎requirements.txt‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
myst_parser
2+
pydata-sphinx-theme
3+
sphinx==6.2.1
4+
sphinx_copybutton==0.5.2
5+
sphinx_markdown_tables==0.0.17

‎source/en/_static/css/readthedocs.css‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.header-logo {
2+
background-image: url("../image/logo.png");
3+
background-size: 180px 40px;
4+
height: 40px;
5+
width: 180px;
6+
}

‎source/en/_static/image/logo.png‎

36.2 KB
Loading

‎source/en/_static/image/logo192.png‎

13.9 KB
Loading

‎source/en/_templates/classtemplate.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.. role:: hidden
2+
:class: hidden-section
3+
.. currentmodule:: {{ module }}
4+
5+
6+
{{ name | underline}}
7+
8+
.. autoclass:: {{ name }}
9+
:members:
10+
11+
12+
..
13+
autogenerated from source/_templates/classtemplate.rst
14+
note it does not have :inherited-members:

‎source/en/conf.py‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# This file only contains a selection of the most common options. For a full
4+
# list see the documentation:
5+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
6+
# from omni.isaac.kit import SimulationApp
7+
8+
# simulation_app = SimulationApp({'headless': True})
9+
import os
10+
import sys
11+
12+
from sphinx.builders.html import StandaloneHTMLBuilder
13+
14+
sys.path.insert(0, os.path.abspath('../..'))
15+
16+
# -- Path setup --------------------------------------------------------------
17+
18+
# If extensions (or modules to document with autodoc) are in another directory,
19+
# add these directories to sys.path here. If the directory is relative to the
20+
# documentation root, use os.path.abspath to make it absolute, like shown here.
21+
#
22+
# import os
23+
# import sys
24+
# sys.path.insert(0, os.path.abspath('.'))
25+
26+
# -- Project information -----------------------------------------------------
27+
28+
project = 'Intern Robotics Engine'
29+
copyright = '2025, OpenRobotLab'
30+
author = 'OpenRobotLab'
31+
32+
# The full version, including alpha/beta/rc tags
33+
release = 'v0.0.1'
34+
35+
# -- General configuration ---------------------------------------------------
36+
37+
# Add any Sphinx extension module names here, as strings. They can be
38+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
39+
# ones.
40+
extensions = [
41+
'sphinx.ext.autodoc',
42+
'sphinx.ext.autosummary',
43+
'sphinx.ext.intersphinx',
44+
'sphinx.ext.napoleon',
45+
'sphinx.ext.viewcode',
46+
'sphinx_markdown_tables',
47+
'myst_parser',
48+
'sphinx_copybutton',
49+
] # yapf: disable
50+
51+
# Add any paths that contain templates here, relative to this directory.
52+
templates_path = ['_templates']
53+
54+
# List of patterns, relative to source directory, that match files and
55+
# directories to ignore when looking for source files.
56+
# This pattern also affects html_static_path and html_extra_path.
57+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
58+
59+
# -- Options for HTML output -------------------------------------------------
60+
61+
# The theme to use for HTML and HTML Help pages. See the documentation for
62+
# a list of builtin themes.
63+
#
64+
# html_theme = 'alabaster'
65+
html_theme = 'pydata_sphinx_theme'
66+
html_logo = '_static/image/logo.png'
67+
html_favicon = '_static/image/logo192.png'
68+
69+
# Define the json_url for our version switcher.
70+
json_url = 'https://pydata-sphinx-theme.readthedocs.io/en/latest/_static/switcher.json'
71+
72+
# Add any paths that contain custom static files (such as style sheets) here,
73+
# relative to this directory. They are copied after the builtin static files,
74+
# so a file named "default.css" will overwrite the builtin "default.css".
75+
html_static_path = ['_static']
76+
77+
html_theme_options = {
78+
'navbar_start': ['navbar-logo'],
79+
'navbar_end': ['theme-switcher', 'navbar-icon-links'],
80+
'navbar_center': ['navbar-nav'],
81+
'secondary_sidebar_items': ['page-toc', 'edit-this-page', 'sourcelink'],
82+
'footer_items': ['copyright', 'sphinx-version'],
83+
'default_mode': 'auto',
84+
'switcher': {
85+
'json_url': 'https://pydata-sphinx-theme.readthedocs.io/en/latest/_static/switcher.json',
86+
'version_match': 'latest',
87+
},
88+
'icon_links': [
89+
{
90+
'name': 'GitHub',
91+
'url': 'https://github.com/OpenRobotLab/GRUtopia.git',
92+
'icon': 'fab fa-github-square',
93+
},
94+
],
95+
'show_nav_level': 2,
96+
'navigation_depth': 4,
97+
# 'collapse_navigation': True,
98+
'show_toc_level': 2,
99+
}
100+
101+
# html_sidebars = {
102+
# '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html']
103+
# }
104+
105+
106+
html_css_files = ['css/readthedocs.css']
107+
108+
# The name of the Pygments (syntax highlighting) style to use.
109+
pygments_style = 'sphinx'
110+
111+
# -- Extension configuration -------------------------------------------------
112+
# Ignore >>> when copying code
113+
copybutton_prompt_text = r'>>> |\.\.\. '
114+
copybutton_prompt_is_regexp = True

0 commit comments

Comments
 (0)