Skip to content
This repository was archived by the owner on Jan 21, 2022. It is now read-only.

Commit 2a8806b

Browse files
max-rosinmax-rosin
authored
Merge pull request #58 from OpenSimulationInterface/56_set_up_initial_document_structure
feat(docs): Create initial document structure (#56)
2 parents ccfd0ec + cd7d2fe commit 2a8806b

23 files changed

+196
-181
lines changed

‎doc/_static/images/Connection.png ‎doc/_images/Connection.png

File renamed without changes.

‎doc/_static/images/Demo.png ‎doc/_images/Demo.png

File renamed without changes.

‎doc/_static/images/FieldOfView.png ‎doc/_images/FieldOfView.png

File renamed without changes.

‎doc/_static/images/PlayBack.png ‎doc/_images/PlayBack.png

File renamed without changes.

‎doc/_static/images/SaveOSIMessage.png ‎doc/_images/SaveOSIMessage.png

File renamed without changes.

‎doc/_static/images/osi_visualizer.png ‎doc/_images/osi_visualizer.png

File renamed without changes.

‎doc/howtocontribute.rst

-33
This file was deleted.

‎doc/misc/idea_visualizer.adoc

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
= The idea of OSI Visualizer
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu.
8+
Velit ut tortor pretium viverra suspendisse.
9+
Amet commodo nulla facilisi nullam vehicula ipsum a.
10+
Nibh nisl condimentum id venenatis a.
11+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/nvidia-docker.rst

-51
This file was deleted.

‎doc/osi-visualizer_user_guide.adoc

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
= OSI Visualizer
2+
:revnumber: v.v.v
3+
:revdate: dd.mm.yyyy
4+
:toc: left
5+
:toclevels: 2
6+
:sectnums:
7+
8+
:topicdir: topics
9+
:reusedir: reuse
10+
11+
// header & footer for html
12+
// html themes
13+
//
14+
// source highlighting
15+
:source-highlighter: rouge
16+
:rouge-style: base16.solarized.light
17+
//
18+
// :nofooter:
19+
:last-update-label!:
20+
//embed images into html
21+
:data-uri:
22+
:mathematical-format: svg
23+
:imagesoutdir: ../images/generated_images
24+
25+
include::./misc/idea_visualizer.adoc[leveloffset=+1]
26+
27+
== Setting up OSI Visualizer
28+
29+
include::./setup/installing_dependencies.adoc[leveloffset=+2]
30+
31+
include::./setup/building_visualizer.adoc[leveloffset=+2]
32+
33+
include::./setup/building_docker.adoc[leveloffset=+2]
34+
35+
== Using OSI Visualizer
36+
37+
include::./use/running_visualizer.adoc[leveloffset=+2]
38+
39+
include::./use/running_visualizer_docker.adoc[leveloffset=+2]
40+
41+
include::./use/receiving_network.adoc[leveloffset=+2]
42+
43+
include::./use/playing_messages.adoc[leveloffset=+2]
44+
45+
include::./use/showing_field_of_view.adoc[leveloffset=+2]
46+
47+
include::./use/saving_messages.adoc[leveloffset=+2]
48+
49+
include::./use/comparing_messages.adoc[leveloffset=+2]
50+
51+
include::./use/configuring_view.adoc[leveloffset=+2]
52+
53+
include::./use/playing_large_files.adoc[leveloffset=+2]

‎doc/panels.rst

-97
This file was deleted.

‎doc/setup/building_docker.adoc

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
= Building OSI visualizer Docker file
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu.
8+
Velit ut tortor pretium viverra suspendisse.
9+
Amet commodo nulla facilisi nullam vehicula ipsum a.
10+
Nibh nisl condimentum id venenatis a.
11+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/setup/building_visualizer.adoc

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
= Building OSI visualizer
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu.
8+
Velit ut tortor pretium viverra suspendisse.
9+
Amet commodo nulla facilisi nullam vehicula ipsum a.
10+
Nibh nisl condimentum id venenatis a.
11+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/setup/installing_dependencies.adoc

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
= Installing dependencies
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu.
8+
Velit ut tortor pretium viverra suspendisse.
9+
Amet commodo nulla facilisi nullam vehicula ipsum a.
10+
Nibh nisl condimentum id venenatis a.
11+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/use/comparing_messages.adoc

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
= Comparing OSI message files
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu.
8+
Velit ut tortor pretium viverra suspendisse.
9+
Amet commodo nulla facilisi nullam vehicula ipsum a.
10+
Nibh nisl condimentum id venenatis a.
11+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/use/configuring_view.adoc

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
= Configuring the view
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu.
8+
Velit ut tortor pretium viverra suspendisse.
9+
Amet commodo nulla facilisi nullam vehicula ipsum a.
10+
Nibh nisl condimentum id venenatis a.
11+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/use/playing_large_files.adoc

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
= Playing back large OSI files
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu.
8+
Velit ut tortor pretium viverra suspendisse.
9+
Amet commodo nulla facilisi nullam vehicula ipsum a.
10+
Nibh nisl condimentum id venenatis a.
11+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/use/playing_messages.adoc

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
= Playing back messages from a trace file
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu.
8+
Velit ut tortor pretium viverra suspendisse.
9+
Amet commodo nulla facilisi nullam vehicula ipsum a.
10+
Nibh nisl condimentum id venenatis a.
11+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/use/receiving_network.adoc

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
= Receiving OSI messages from a network
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu.
8+
Velit ut tortor pretium viverra suspendisse.
9+
Amet commodo nulla facilisi nullam vehicula ipsum a.
10+
Nibh nisl condimentum id venenatis a.
11+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/use/running_visualizer.adoc

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
= Running OSI visualizer
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu.
8+
Velit ut tortor pretium viverra suspendisse.
9+
Amet commodo nulla facilisi nullam vehicula ipsum a.
10+
Nibh nisl condimentum id venenatis a.
11+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/use/running_visualizer_docker.adoc

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
= Running OSI visualizer using Docker
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu.
8+
Velit ut tortor pretium viverra suspendisse.
9+
Amet commodo nulla facilisi nullam vehicula ipsum a.
10+
Nibh nisl condimentum id venenatis a.
11+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

‎doc/use/saving_messages.adoc

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
= Saving OSI messages
2+
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4+
Et malesuada fames ac turpis egestas.
5+
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6+
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7+
Sed augue lacus viverra vitae congue eu.
8+
Velit ut tortor pretium viverra suspendisse.
9+
Amet commodo nulla facilisi nullam vehicula ipsum a.
10+
Nibh nisl condimentum id venenatis a.
11+
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.

0 commit comments

Comments
 (0)