Skip to content

Commit f9b0a64

Browse files
Samuel-DrewSamuel-Drew
committed
2 parents 02ac185 + e132a29 commit f9b0a64

12 files changed

+522
-10
lines changed

‎.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Toolbox builds
2-
spatialmath/docs/build
32

43
# Byte-compiled / optimized / DLL files
54
__pycache__
@@ -72,7 +71,7 @@ instance/
7271
.scrapy
7372

7473
# Sphinx documentation
75-
docs/_build/
74+
doc/build/
7675

7776
# PyBuilder
7877
.pybuilder/

‎doc/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
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)

‎doc/make.bat

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
13+
if "%1" == "" goto help
14+
15+
%SPHINXBUILD% >NUL 2>NUL
16+
if errorlevel 9009 (
17+
echo.
18+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19+
echo.installed, then set the SPHINXBUILD environment variable to point
20+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
21+
echo.may add the Sphinx directory to PATH.
22+
echo.
23+
echo.If you don't have Sphinx installed, grab it from
24+
echo.http://sphinx-doc.org/
25+
exit /b 1
26+
)
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

‎doc/source/conf.py

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
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+
7+
# -- Path setup --------------------------------------------------------------
8+
9+
# If extensions (or modules to document with autodoc) are in another directory,
10+
# add these directories to sys.path here. If the directory is relative to the
11+
# documentation root, use os.path.abspath to make it absolute, like shown here.
12+
#
13+
import os
14+
import sys
15+
sys.path.insert(0, os.path.abspath('../../roboticstoolbox'))
16+
17+
18+
# -- Project information -----------------------------------------------------
19+
20+
project = 'Robotics Toolbox for Python'
21+
copyright = '2020'
22+
author = 'many'
23+
24+
# The full version, including alpha/beta/rc tags
25+
release = '0.5'
26+
27+
28+
# -- General configuration ---------------------------------------------------
29+
30+
# Add any Sphinx extension module names here, as strings. They can be
31+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32+
# ones.
33+
extensions = [
34+
'sphinx.ext.autodoc',
35+
'sphinx.ext.todo',
36+
'sphinx.ext.viewcode',
37+
'sphinx.ext.mathjax',
38+
'sphinx.ext.coverage',
39+
'sphinx.ext.inheritance_diagram',
40+
]
41+
42+
# Add any paths that contain templates here, relative to this directory.
43+
templates_path = ['_templates']
44+
45+
# List of patterns, relative to source directory, that match files and
46+
# directories to ignore when looking for source files.
47+
# This pattern also affects html_static_path and html_extra_path.
48+
exclude_patterns = ['test_*', 'untitled*']
49+
50+
51+
# -- Options for HTML output -------------------------------------------------
52+
53+
# The theme to use for HTML and HTML Help pages. See the documentation for
54+
# a list of builtin themes.
55+
#
56+
html_theme = 'alabaster'
57+
58+
# Add any paths that contain custom static files (such as style sheets) here,
59+
# relative to this directory. They are copied after the builtin static files,
60+
# so a file named "default.css" will overwrite the builtin "default.css".
61+
html_static_path = ['_static']

‎doc/source/index.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. Robotics Toolbox for Python documentation master file, created by
2+
sphinx-quickstart on Thu Sep 3 15:26:23 2020.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to Robotics Toolbox for Python's documentation!
7+
=======================================================
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
:caption: Contents:
12+
13+
14+
15+
Indices and tables
16+
==================
17+
18+
* :ref:`genindex`
19+
* :ref:`modindex`
20+
* :ref:`search`

‎doc/source/modules.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
roboticstoolbox
2+
===============
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
7+
roboticstoolbox

‎doc/source/roboticstoolbox.models.rst

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
roboticstoolbox.models package
2+
==============================
3+
4+
Submodules
5+
----------
6+
7+
roboticstoolbox.models.Panda module
8+
-----------------------------------
9+
10+
.. automodule:: roboticstoolbox.models.Panda
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
roboticstoolbox.models.PandaMDH module
16+
--------------------------------------
17+
18+
.. automodule:: roboticstoolbox.models.PandaMDH
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
roboticstoolbox.models.Puma560 module
24+
-------------------------------------
25+
26+
.. automodule:: roboticstoolbox.models.Puma560
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
roboticstoolbox.models.graphical\_puma560 module
32+
------------------------------------------------
33+
34+
.. automodule:: roboticstoolbox.models.graphical_puma560
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
40+
Module contents
41+
---------------
42+
43+
.. automodule:: roboticstoolbox.models
44+
:members:
45+
:undoc-members:
46+
:show-inheritance:

0 commit comments

Comments
 (0)