Skip to content

Commit 0d54702

Browse files
fmricofmrico
committed
first commit
0 parents  commit 0d54702

27 files changed

+1177
-0
lines changed

‎LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎Makefile

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
ifeq ($(VERBOSE),1)
5+
Q =
6+
else
7+
Q = @
8+
endif
9+
10+
# You can set these variables from the command line.
11+
SPHINXOPTS ?= -q
12+
SPHINXBUILD = sphinx-build
13+
SPHINXPROJ = "ROS2 Planning System Documentation"
14+
SOURCEDIR = .
15+
BUILDDIR = _build
16+
17+
DOC_TAG ?= development
18+
RELEASE ?= latest
19+
PUBLISHDIR = /tmp/CoreSenseEU
20+
21+
# Put it first so that "make" without argument is like "make help".
22+
help:
23+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
24+
@echo ""
25+
@echo "make publish"
26+
@echo " publish generated html to thesofproject.github.io site:"
27+
@echo " specify RELEASE=name to publish as a tagged release version"
28+
@echo " and placed in a version subfolder. Requires repo merge permission."
29+
30+
.PHONY: help Makefile
31+
32+
# Generate the doxygen xml (for Sphinx) and copy the doxygen html to the
33+
# api folder for publishing along with the Sphinx-generated API docs.
34+
35+
html:
36+
$(Q)$(SPHINXBUILD) -t $(DOC_TAG) -b html -d $(BUILDDIR)/doctrees $(SOURCEDIR) $(BUILDDIR)/html $(SPHINXOPTS) $(O)
37+
38+
# Remove generated content (Sphinx and doxygen)
39+
40+
clean:
41+
rm -fr $(BUILDDIR)
42+
43+
# Copy material over to the GitHub pages staging repo
44+
# along with a README
45+
46+
publish:
47+
git clone --reference . https://github.com/CoreSenseEU/CoreSenseEU.github.io.git $(PUBLISHDIR)
48+
cd $(PUBLISHDIR) && \
49+
git checkout gh-pages && \
50+
git config user.email "[email protected]" && \
51+
git config user.name "fmrico"
52+
rm -fr $(PUBLISHDIR)/*
53+
cp -r $(BUILDDIR)/html/* $(PUBLISHDIR)
54+
cp scripts/.nojekyll $(PUBLISHDIR)/.nojekyll
55+
# cp scripts/CNAME $(PUBLISHDIR)/CNAME
56+
cd $(PUBLISHDIR) && \
57+
git add -A && \
58+
git diff-index --quiet HEAD || \
59+
(git commit -s -m "[skip ci] publish $(RELEASE)" && git push origin)
60+
61+
62+
# Catch-all target: route all unknown targets to Sphinx using the new
63+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
64+
%: Makefile doxy
65+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎README.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# CoreSenseEU.github.io
2+
https://github.com/CoreSenseEU/CoreSenseEU.github.io
3+
4+
This folder holds the source and configuration files used to generate the
5+
[CoreSenseEU documentation](http://CoreSenseEU.github.io) web site.
6+
7+
Dependencies for Build:
8+
* [Sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html)
9+
* `sudo apt install python3-pip`
10+
* `pip3 install breathe==4.30.0 sphinx_rtd_theme sphinxcontrib-plantuml`
11+
12+
Build the docs locally with `make html` and you'll find the built docs entry point in `_build/html/index.html`.
13+

‎_config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
theme: jekyll-theme-slate

‎_themes/otc_tcs_sphinx_theme/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
__pycache__

‎_themes/otc_tcs_sphinx_theme/layout.html

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{% extends "sphinx_rtd_theme/layout.html" %}
2+
3+
{% block extrahead %}
4+
5+
<link rel="stylesheet" href="{{ pathto('_static/tcs_theme.css', 1) }}" type="text/css" />
6+
7+
{% endblock %}
8+
9+
{% block content %}
10+
11+
<span style="float: right;" >
12+
<a class="github-button" href="https://github.com/CoreSenseEU/CoreSenseEU.github.io" data-color-scheme="no-preference: light; light: light; dark: dark;" data-size="large" aria-label="Edit IntelligentRoboticsLabs/CoreSenseEU.github.io on GitHub" ">Edit</a>
13+
</span>
14+
15+
{{ super() }}
16+
17+
{% endblock %}
18+
19+
{% block footer %}
20+
21+
<script type="text/javascript" src="{{ pathto('_static/tcs_theme.js', 1) }}"></script>
22+
<script async defer src="https://buttons.github.io/buttons.js"></script>
23+
24+
{% endblock %}

‎_themes/otc_tcs_sphinx_theme/readme.rst

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
OTC-TCS Sphinx Theme
2+
####################
3+
4+
Built on top of the popular Read the Docs Sphinx theme, this theme
5+
has a few small formatting/color improvements and implements collapsible
6+
sections. It is in active development in order to support OTC and other
7+
Intel organizations to publish high quality, consistent documentation
8+
for open source projects.
9+
10+
How to use it
11+
*************
12+
13+
#. Download or clone the repository
14+
#. Create a ``_themes`` directory in main directory of your sphinx
15+
documentation
16+
#. Install sphinx_rtd_theme using pip: ``pip3 install sphinx_rtd_theme``
17+
#. copy ``otc_tcs_sphinx_theme`` directory into the new ``_themes`` directory
18+
#. Add the following to your ``conf.py``:
19+
20+
.. code-block:: python
21+
22+
html_theme = 'otc_tcs_sphinx_theme'
23+
html_theme_path = ['_themes']

0 commit comments

Comments
 (0)