Skip to content

Commit a7b4ca3

Browse files
committed
Create docs files
1 parent ff2f1e9 commit a7b4ca3

File tree

7 files changed

+24
-2
lines changed

7 files changed

+24
-2
lines changed

docs/_static/openEditor.png

57.7 KB
Loading

docs/conf.py

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
# import sys
1515
# sys.path.insert(0, os.path.abspath('.'))
1616

17+
import sphinx_rtd_theme
18+
1719

1820
# -- Project information -----------------------------------------------------
1921

@@ -30,7 +32,11 @@
3032
# Add any Sphinx extension module names here, as strings. They can be
3133
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3234
# ones.
33-
extensions = ['myst_parser']
35+
extensions = [
36+
'myst_parser',
37+
'sphinx.ext.autodoc',
38+
'sphinx.ext.napoleon',
39+
]
3440

3541
# Add any paths that contain templates here, relative to this directory.
3642
# templates_path = ['_templates']
@@ -48,7 +54,8 @@
4854
# The theme to use for HTML and HTML Help pages. See the documentation for
4955
# a list of builtin themes.
5056
#
51-
html_theme = 'alabaster'
57+
html_theme = 'sphinx_rtd_theme'
58+
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
5259

5360
# Add any paths that contain custom static files (such as style sheets) here,
5461
# relative to this directory. They are copied after the builtin static files,

docs/examples.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Examples

docs/index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,15 @@ Welcome to jupyterlab-urdf's documentation!
1010
:maxdepth: 2
1111
:caption: Contents:
1212

13+
installation
14+
15+
.. toctree::
16+
:maxdepth: 2
17+
:caption: Usage:
18+
19+
urdf_editor
20+
urdf_viewer
21+
examples
1322

1423

1524
Indices and tables

docs/installation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Installation

docs/urdf_editor.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# URDF Editor
2+
3+
To open the text editor for any URDF file, simply right click on the file and select "Open With" "Editor".

docs/urdf_viewer.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# URDF Viewer

0 commit comments

Comments
 (0)