Skip to content

Commit e7d3108

Browse files
simil-fork from erl2
0 parents  commit e7d3108

File tree

1,119 files changed

+177608
-0
lines changed

Some content is hidden

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

1,119 files changed

+177608
-0
lines changed

Makefile

+20
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 = .
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

+37

_build/doctrees/README.doctree

10.4 KB
Binary file not shown.
7.05 KB
Binary file not shown.
Binary file not shown.

_build/doctrees/_docs/dev-log.doctree

474 KB
Binary file not shown.
Binary file not shown.
18.1 KB
Binary file not shown.
2.78 KB
Binary file not shown.
5.04 KB
Binary file not shown.
6.96 KB
Binary file not shown.
138 KB
Binary file not shown.
5.14 KB
Binary file not shown.
2.95 KB
Binary file not shown.
17.5 KB
Binary file not shown.

_build/doctrees/_uml/arch.doctree

8.63 KB
Binary file not shown.

_build/doctrees/environment.pickle

1020 KB
Binary file not shown.

_build/doctrees/index.doctree

5.37 KB
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
5.46 KB
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
6.62 KB
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

_build/html/.buildinfo

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 4e89e849b7c35487c329abc45af66e3b
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

_build/html/.nojekyll

Whitespace-only changes.

_build/html/README.html

+222
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,222 @@
1+
<!DOCTYPE html>
2+
<html class="writer-html5" lang="en" >
3+
<head>
4+
<meta charset="utf-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6+
<title>README – the RoboCLuedo Project – part 2 &mdash; RobotCLuedo 1.0.0 documentation</title>
7+
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
8+
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
9+
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
10+
<link rel="stylesheet" href="_static/assets/jsonview.bundle.css" type="text/css" />
11+
<link rel="stylesheet" href="_static/sphinx-needs/libs/html/datatables.min.css" type="text/css" />
12+
<link rel="stylesheet" href="_static/sphinx-needs/common.css" type="text/css" />
13+
<link rel="stylesheet" href="_static/sphinx-needs/modern.css" type="text/css" />
14+
<link rel="stylesheet" href="_static/sphinx-needs/layouts.css" type="text/css" />
15+
<link rel="stylesheet" href="_static/sphinx-needs/styles.css" type="text/css" />
16+
<!--[if lt IE 9]>
17+
<script src="_static/js/html5shiv.min.js"></script>
18+
<![endif]-->
19+
20+
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
21+
<script src="_static/jquery.js"></script>
22+
<script src="_static/underscore.js"></script>
23+
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
24+
<script src="_static/doctools.js"></script>
25+
<script src="_static/assets/jsonview.bundle.js"></script>
26+
<script src="_static/assets/jsonview_loader.js"></script>
27+
<script src="_static/sphinx-needs/libs/html/datatables.min.js"></script>
28+
<script src="_static/sphinx-needs/libs/html/datatables_loader.js"></script>
29+
<script src="_static/sphinx-needs/libs/html/sphinx_needs_collapse.js"></script>
30+
<script src="_static/js/theme.js"></script>
31+
<link rel="index" title="Index" href="genindex.html" />
32+
<link rel="search" title="Search" href="search.html" />
33+
<link rel="next" title="UML – components schema of the project" href="_uml/arch.html" />
34+
<link rel="prev" title="RCL – the RoboCLuedo Project - part 2" href="index.html" />
35+
</head>
36+
37+
<body class="wy-body-for-nav">
38+
<div class="wy-grid-for-nav">
39+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
40+
<div class="wy-side-scroll">
41+
<div class="wy-side-nav-search" >
42+
<a href="index.html" class="icon icon-home"> RobotCLuedo
43+
</a>
44+
<div role="search">
45+
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
46+
<input type="text" name="q" placeholder="Search docs" />
47+
<input type="hidden" name="check_keywords" value="yes" />
48+
<input type="hidden" name="area" value="default" />
49+
</form>
50+
</div>
51+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
52+
<p class="caption" role="heading"><span class="caption-text">README</span></p>
53+
<ul class="current">
54+
<li class="toctree-l1 current"><a class="current reference internal" href="#">the project main README</a></li>
55+
<li class="toctree-l1"><a class="reference internal" href="_uml/arch.html">UML overall arch</a></li>
56+
</ul>
57+
<p class="caption" role="heading"><span class="caption-text">Packages Documentation</span></p>
58+
<ul>
59+
<li class="toctree-l1"><a class="reference internal" href="robocluedo_armor_msgs/index.html">PKG DOCS – robocluedo_armor_msgs</a></li>
60+
<li class="toctree-l1"><a class="reference internal" href="robocluedo_armor/index.html">PKG DOCS – robocluedo armor</a></li>
61+
<li class="toctree-l1"><a class="reference internal" href="robocluedo_rosplan/index.html">PKG DOCS – robocluedo_rosplan</a></li>
62+
<li class="toctree-l1"><a class="reference internal" href="robocluedo_rosplan_msgs/index.html">PKG DOCS – robocluedo_rosplan_msgs</a></li>
63+
<li class="toctree-l1"><a class="reference internal" href="robocluedo_movement_controller/index.html">PKG DOCS – robocluedo_movement_controller</a></li>
64+
<li class="toctree-l1"><a class="reference internal" href="robocluedo_movement_controller_msgs/index.html">PKG DOCS – robocluedo_movement_msgs</a></li>
65+
<li class="toctree-l1"><a class="reference internal" href="robocluedo_module_testing/index.html">PKG DOCS – RoboCLuedo Module Testing</a></li>
66+
</ul>
67+
<p class="caption" role="heading"><span class="caption-text">Dependencies Documentation</span></p>
68+
<ul>
69+
<li class="toctree-l1"><a class="reference internal" href="robocluedo_dependencies/_docs/erl2-oracle-user-manual.html">Oracle (for the ERL project no.2) – User Documentation</a></li>
70+
<li class="toctree-l1"><a class="reference internal" href="robocluedo_dependencies/_docs/robocluedo-urdf-user-manual.html">the RoboCLuedo Project no.2 – robot URDF model – User Manual</a></li>
71+
<li class="toctree-l1"><a class="reference internal" href="robocluedo_dependencies/_docs/worlds-user-manual.html">WORLDS – a collection of Gazebo World Files</a></li>
72+
</ul>
73+
<p class="caption" role="heading"><span class="caption-text">Other Documents</span></p>
74+
<ul>
75+
<li class="toctree-l1"><a class="reference internal" href="_docs/catkin-notes.html">Notes about Catkin</a></li>
76+
<li class="toctree-l1"><a class="reference internal" href="_docs/cpp-docs-template.html">Documentation for c++ nodes and libraries</a></li>
77+
<li class="toctree-l1"><a class="reference internal" href="_docs/dev-log.html">RoboCLuedo – Development Log</a></li>
78+
<li class="toctree-l1"><a class="reference internal" href="_docs/how-to-setup-doxy-sphinx-ws.html">How to setup a Doxygen/Sphinx workspace</a></li>
79+
<li class="toctree-l1"><a class="reference internal" href="_docs/how-to-setup-doxy-sphinx-ws.html#sphinx-config-file-configuration">Sphinx – config file configuration</a></li>
80+
<li class="toctree-l1"><a class="reference internal" href="_docs/rest-directives.html">ReStructured Directives – practical documentation</a></li>
81+
<li class="toctree-l1"><a class="reference internal" href="_docs/run-the-project.html">How to Run this Project</a></li>
82+
<li class="toctree-l1"><a class="reference internal" href="_docs/sphinx-mock.html">Sphinx for Py – modules mocking</a></li>
83+
<li class="toctree-l1"><a class="reference internal" href="_docs/sphinx-yaml.html">YAML and Sphinx</a></li>
84+
<li class="toctree-l1"><a class="reference internal" href="_docs/test-the-project.html">Testing the project</a></li>
85+
<li class="toctree-l1"><a class="reference internal" href="_docs/twist-keyboard.html">HOW TO – twist keyboard</a></li>
86+
</ul>
87+
<p class="caption" role="heading"><span class="caption-text">General Code Examples</span></p>
88+
<ul>
89+
<li class="toctree-l1"><a class="reference internal" href="_examples/examples-index.html">Code Examples</a></li>
90+
</ul>
91+
<p class="caption" role="heading"><span class="caption-text">Extensions and other references</span></p>
92+
<ul>
93+
<li class="toctree-l1"><a class="reference internal" href="_ext/plant-uml-reference.html">PlantUML quick reference</a></li>
94+
</ul>
95+
96+
</div>
97+
</div>
98+
</nav>
99+
100+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
101+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
102+
<a href="index.html">RobotCLuedo</a>
103+
</nav>
104+
105+
<div class="wy-nav-content">
106+
<div class="rst-content">
107+
<div role="navigation" aria-label="Page navigation">
108+
<ul class="wy-breadcrumbs">
109+
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
110+
<li>README – the RoboCLuedo Project – part 2</li>
111+
<li class="wy-breadcrumbs-aside">
112+
<a href="_sources/README.md.txt" rel="nofollow"> View page source</a>
113+
</li>
114+
</ul>
115+
<hr/>
116+
</div>
117+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
118+
<div itemprop="articleBody">
119+
120+
<div class="section" id="readme-the-robocluedo-project-part-2">
121+
<h1>README – the RoboCLuedo Project – part 2<a class="headerlink" href="#readme-the-robocluedo-project-part-2" title="Permalink to this heading"></a></h1>
122+
<ul class="simple">
123+
<li><p>what is this</p>
124+
<ul>
125+
<li><p>project tree</p></li>
126+
<li><p>aims of the project</p></li>
127+
</ul>
128+
</li>
129+
<li><p>how to install the project</p>
130+
<ul>
131+
<li><p>dependencies:</p>
132+
<ul>
133+
<li><p>moveit</p></li>
134+
<li><p>ROSPlan</p></li>
135+
<li><p>slam gmapping</p></li>
136+
</ul>
137+
</li>
138+
<li><p>tools:</p>
139+
<ul>
140+
<li><p>docker</p></li>
141+
</ul>
142+
</li>
143+
<li><p>setup procedure</p></li>
144+
</ul>
145+
</li>
146+
<li><p>how to run the project</p>
147+
<ul>
148+
<li><p>easy run</p></li>
149+
<li><p>manual run with a short project presentation</p></li>
150+
<li><p>module testing:</p>
151+
<ul>
152+
<li><p></p></li>
153+
</ul>
154+
</li>
155+
</ul>
156+
</li>
157+
<li><p>how to use the documentation system</p>
158+
<ul>
159+
<li><p>documentation system setup (usa lo script)</p></li>
160+
<li><p>come rigenerare la documentazione</p></li>
161+
<li><p>file principali della documentazione</p></li>
162+
</ul>
163+
</li>
164+
<li><p>TROUBLESHOOTING</p>
165+
<ul>
166+
<li><p>sicuro la roba su tutti i problemi del Docker del corso</p></li>
167+
<li><p></p></li>
168+
</ul>
169+
</li>
170+
<li><p>discussione del progetto</p>
171+
<ul>
172+
<li><p>… (sarebbe meglio fare questo lavoro nella documentazione Sphinx?)</p></li>
173+
</ul>
174+
</li>
175+
<li><p>authors and contacts</p>
176+
<ul>
177+
<li><p>(questa è facile…)</p></li>
178+
</ul>
179+
</li>
180+
</ul>
181+
<div class="section" id="scopi-del-progetto">
182+
<h2>scopi del progetto<a class="headerlink" href="#scopi-del-progetto" title="Permalink to this heading"></a></h2>
183+
<ul class="simple">
184+
<li><p>implementazione di un’architettura …</p></li>
185+
<li><p>sfruttare maggiormente il formalismo UML per migliorare la progettazione</p></li>
186+
<li><p>sfruttare meglio la documentazione (documentazione non solo come parte finale del codice, ma anche come ambiente di lavoro)</p></li>
187+
</ul>
188+
</div>
189+
</div>
190+
191+
192+
</div>
193+
</div>
194+
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
195+
<a href="index.html" class="btn btn-neutral float-left" title="RCL – the RoboCLuedo Project - part 2" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
196+
<a href="_uml/arch.html" class="btn btn-neutral float-right" title="UML – components schema of the project" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
197+
</div>
198+
199+
<hr/>
200+
201+
<div role="contentinfo">
202+
<p>&#169; Copyright 2022, Francesco Ganci.</p>
203+
</div>
204+
205+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
206+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
207+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
208+
209+
210+
</footer>
211+
</div>
212+
</div>
213+
</section>
214+
</div>
215+
<script>
216+
jQuery(function () {
217+
SphinxRtdTheme.Navigation.enable(true);
218+
});
219+
</script>
220+
221+
</body>
222+
</html>

0 commit comments

Comments
 (0)