simplified exercise template

duckietown · Oct 14, 2022 · 13cdbb4 · 13cdbb4
1 parent b1e5d67
commit 13cdbb4
Show file tree

Hide file tree

Showing 17 changed files with 32 additions and 197 deletions.
diff --git a/.dockerignore b/.dockerignore
diff --git a/Dockerfile b/Dockerfile
diff --git a/README.md b/README.md
@@ -1,47 +1,3 @@
-# Template: template-exercise
+# Exercise: <EXERCISE_NAME_HERE>
 
-This template provides a boilerplate repository
-for developing ROS-based software in Duckietown.
-
-**NOTE:** If you want to develop software that does not use
-ROS, check out [this template](https://github.com/duckietown/template-basic).
-
-
-## How to use it
-
-### 1. Fork this repository
-
-Use the fork button in the top-right corner of the github page to fork this template repository.
-
-
-### 2. Create a new repository
-
-Create a new repository on github.com while
-specifying the newly forked template repository as
-a template for your new repository.
-
-
-### 3. Define dependencies
-
-List the dependencies in the files `dependencies-apt.txt` and
-`dependencies-py3.txt` (apt packages and pip packages respectively).
-
-
-### 4. Place your code
-
-Place your code in the directory `/packages/` of
-your new repository.
-
-
-### 5. Setup launchers
-
-The directory `/launchers` can contain as many launchers (launching scripts)
-as you want. A default launcher called `default.sh` must always be present.
-
-If you create an executable script (i.e., a file with a valid shebang statement)
-a launcher will be created for it. For example, the script file 
-`/launchers/my-launcher.sh` will be available inside the Docker image as the binary
-`dt-launcher-my-launcher`.
-
-When launching a new container, you can simply provide `dt-launcher-my-launcher` as
-command.
+TODO: write documentation about the exercise here
diff --git a/assets/STORE_MODULE_ASSETS_HERE → assets/STORE_EXERCISE_ASSETS_HERE b/assets/STORE_MODULE_ASSETS_HERE → assets/STORE_EXERCISE_ASSETS_HERE
diff --git a/configurations.yaml b/configurations.yaml
diff --git a/dependencies-apt.txt b/dependencies-apt.txt
diff --git a/dependencies-py3.txt b/dependencies-py3.txt
diff --git a/docs/config.yaml b/docs/config.yaml
@@ -1,25 +1,28 @@
 docs_config_version: v1
 
 # CONFIGURE THESE TO MATCH YOUR PROJECT:
-project: "REPOSITORY_NAME_HERE"
+
+# TODO: these should be provided by `dts devel docs build ...`
+#project: "EXERCISE_NAME_HERE"
+#author: "YOUR_NAME_HERE"
+#version: "-"
+
 copyright: "Duckietown"
-author: "YOUR_NAME_HERE"
-version: "daffy"
-custom_sections:  [
-  "Configuration",
-  "Subscribers",
-  "Subscriber",
-  "Publishers",
-  "Publisher",
-  "Services",
-  "Service",
-  "Fields",
-  "Attribute",
-  "Attributes",
-  "inputs",
-  "input",
-  "outputs",
-  "output"
+custom_sections: [
+    "Configuration",
+    "Subscribers",
+    "Subscriber",
+    "Publishers",
+    "Publisher",
+    "Services",
+    "Service",
+    "Fields",
+    "Attribute",
+    "Attributes",
+    "inputs",
+    "input",
+    "outputs",
+    "output"
 ]
 
 # REFRAIN FROM CHANGING THESE SPHINX-SPECIFIC CONFIGURATION SETTINGS:
@@ -55,4 +58,3 @@ html_theme_options:
   navigation_depth: 4
   includehidden: False
   titles_only: False
-
diff --git a/docs/index.rst b/docs/index.rst
@@ -4,8 +4,8 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to REPOSITORY_NAME_HERE documentation!
-==============================================
+Documentation
+=============
 
 .. toctree::
    :maxdepth: 1

diff --git a/docs/mock_imports b/docs/mock_imports
diff --git a/docs/packages.rst b/docs/packages.rst
@@ -1,5 +1,5 @@
-Duckietown Module: REPOSITORY_NAME_HERE
-=======================================
+Packages
+========
 
 .. toctree::
    :glob:

diff --git a/docs/packages/example.rst b/docs/packages/example.rst
@@ -1,6 +1,6 @@
-Python Package: example
-=======================
+Documentation: example
+======================
 
 .. contents::
 
-TODO: This is a placeholder description of the Python Package.
+Write your documentation here.
diff --git a/html/HTML_DOCS_WILL_BE_GENERATED_HERE b/html/HTML_DOCS_WILL_BE_GENERATED_HERE
diff --git a/launchers/default.sh b/launchers/default.sh
diff --git a/packages/PLACE_YOUR_ROS_PACKAGES_HERE → notebooks/PLACE_YOUR_JUPYTER_NOTEBOOKS_HERE b/packages/PLACE_YOUR_ROS_PACKAGES_HERE → notebooks/PLACE_YOUR_JUPYTER_NOTEBOOKS_HERE
diff --git a/packages/PLACE_YOUR_CODE_HERE b/packages/PLACE_YOUR_CODE_HERE
@@ -0,0 +1 @@
+# INTENTIONALLY LEFT BLANK
diff --git a/tests/PLACE_YOUR_TESTS_HERE b/tests/PLACE_YOUR_TESTS_HERE
@@ -0,0 +1 @@
+# INTENTIONALLY LEFT BLANK