Merge pull request #318 from una-auxme/315-feature-remove-pycharm-fro…

…m-project

315 feature remove pycharm from project

.markdownlint.yaml

@@ -6,7 +6,7 @@ MD013:
   tables: false
 
 MD004:
-  style: "consistent"
+  style: dash
 
 MD051: false
 

build/docker/agent/Dockerfile

@@ -139,7 +139,7 @@ ENV CARLA_SIM_HOST=localhost
 ENV CARLA_SIM_WAIT_SECS=15
 ENV SCENARIO_RUNNER_PATH=/opt/scenario_runner
 
-# setup python path for PyCharm integration
+# setup python path
 RUN echo /catkin_ws/install/lib/python3/dist-packages >> /home/$USERNAME/.local/lib/python3.8/site-packages/carla.pth && \
     echo /catkin_ws/devel/lib/python3/dist-packages >> /home/$USERNAME/.local/lib/python3.8/site-packages/carla.pth && \
     echo /opt/ros/noetic/lib/python3/dist-packages >> /home/$USERNAME/.local/lib/python3.8/site-packages/carla.pth && \

build/docker/agent/Dockerfile_Submission

@@ -141,7 +141,7 @@ ENV CARLA_SIM_HOST=localhost
 ENV CARLA_SIM_WAIT_SECS=15
 ENV SCENARIO_RUNNER_PATH=/opt/scenario_runner
 
-# setup python path for PyCharm integration
+# setup python path
 RUN echo /catkin_ws/install/lib/python3/dist-packages >> /home/$USERNAME/.local/lib/python3.8/site-packages/carla.pth && \
     echo /catkin_ws/devel/lib/python3/dist-packages >> /home/$USERNAME/.local/lib/python3.8/site-packages/carla.pth && \
     echo /opt/ros/noetic/lib/python3/dist-packages >> /home/$USERNAME/.local/lib/python3.8/site-packages/carla.pth && \

doc/02_development/04_coding_style.md

@@ -20,10 +20,6 @@ VSCode Extensions:
 
 - autoDostring - Python Docstring Generator by Nils Werner
 
-To get the ReST format like in Pycharm:
-
-- Go to Extension setting and change it under `Auto Doctring:Docstring Format` to `sphinx-notypes`
-
 ---
 <!-- TOC -->
 - [Coding style guidelines](#coding-style-guidelines)

doc/02_development/08_project_management.md

@@ -86,12 +86,6 @@ CARLA simulator crashes on startup on your machine.
 To create a pull request, go to the [branches overview](https://github.com/ll7/paf22/branches) and select ``New Pull Request`` for the branch you want to create a PR for.
 ![img.png](../00_assets/branch_overview.png)
 
-Alternatively you can create a PR directly from PyCharm using the ``Pull Request`` tab on the sidebar.
-
-![img.png](../00_assets/Pycharm_PR.png)
-
-For completing the pull request, fill out the template that opens up automatically.
-
 Merge the pull request after the review process is complete and all the feedback from the reviewer has been worked in.
 
 For more information about the review process, see [Review process](./07_review_guideline.md).

doc/02_development/templates/template_class.py

@@ -71,29 +71,15 @@ def test_function3(self):  # inline comment
     #   6. Docstrings           #
     #############################
     def test_function4(self, param1, param2):
-        # This docstring style is supported by Sphinx and helps with automated API documentation creation, automatically created by PyCharm
-        """
-        This is the description of the function.
+        # This docstring style is the default google style of the autoDocstring extension and helps with automated API documentation creation
+        """This is the description of the function.
 
-        :param param1: first parameter
-        :param param2: second parameter
-        :return: return value(s)
+        Args:
+            param1 (_type_): _description_
+            param2 (_type_): _description_
         """
         pass
 
-    def test_function5(self, param1, param2):
-        # This docstring style is supported by Sphinx and helps with automated API documentation creation, automatically created by VSCode extension autoDocstring
-        # VSCode Extentsion: autoDocstring- Python Docstring Generator by Nils Werner
-        # To get the ReST format like in Pycharm
-        # Go to Extension setting and change it under `Auto Doctring:Docstring Format` to `sphinx-notypes`
-        """_summary_
-
-        :param param1: _description_
-        :param param2: _description_
-        :return: _description_
-        """
-        return param1
-
     # main function of the class
     def main(self):
         print("Hello World")

doc/02_development/templates/template_wiki_page.md

@@ -16,38 +16,28 @@ Josef Kircher
 
 VSCode Extensions:
 
-* Markdown All in One by Yu Zhang (for TOC)
+- Markdown All in One by Yu Zhang (for TOC)
 
 ---
 
-How to generate a TOC in VSCode and Pycharm:
+How to generate a TOC in VSCode:
 
 VSCode:
 
-1. Install Markdown All in One via Extensions
-2. ``Ctrl+Shift+P``
-3. Command "Create Table of Contents"
-
-Cosmetic change: Markdown All in One uses `-` as unordered list indicator, to change it to `*` like in Pycharm
-
-Go to Extension setting and change it under `Markdown>Extension>Toc>Unordered List:Marker`
-
-Pycharm:
-
-1. ``Alt+Ins``
-2. Select Table of Contents
-3. To update Table of Contents follow Step 1. and select Update Table of Contents
+1. ``Ctrl+Shift+P``
+2. Command "Create Table of Contents"
 
 <!-- TOC -->
-* [Title of wiki page](#title-of-wiki-page)
-  * [Author](#author)
-  * [Date](#date)
-  * [Prerequisite](#prerequisite)
-  * [Cheat Sheet](#cheat-sheet)
-    * [Basics](#basics)
-    * [Extended](#extended)
-  * [more Content](#more-content)
-    * [Sources](#sources)
+- [Title of wiki page](#title-of-wiki-page)
+  - [Author](#author)
+  - [Date](#date)
+  - [Prerequisite](#prerequisite)
+  - [Cheat Sheet](#cheat-sheet)
+    - [Basics](#basics)
+    - [Extended](#extended)
+      - [My Great Heading {#custom-id}](#my-great-heading-custom-id)
+  - [more Content](#more-content)
+    - [Sources](#sources)
 <!-- TOC -->
 
 ## Cheat Sheet
@@ -84,9 +74,9 @@ Ordered List
 ---
 Unordered List
 
-* First item
-* Second item
-* Third item
+- First item
+- Second item
+- Third item
 
 ---
 Code  
@@ -152,10 +142,10 @@ Strikethrough
 
 Task List
 
-* [x] Write the press release
-* [ ] Update the website
+- [x] Write the press release
+- [ ] Update the website
 
-* [ ] Contact the media
+- [ ] Contact the media
 
 ---
 

doc/02_development/templates/template_wiki_page_empty.md

@@ -16,18 +16,20 @@ Josef Kircher
 
 VSCode Extensions:
 
-* Markdown All in One by Yu Zhang (for TOC)
+- Markdown All in One by Yu Zhang (for TOC)
 
 ---
+
 <!-- TOC -->
-* [Title of wiki page](#title-of-wiki-page)
-  * [Author](#author)
-  * [Date](#date)
-  * [Prerequisite](#prerequisite)
-  * [Some Content](#some-content)
-  * [more Content](#more-content)
-    * [Sources](#sources)
+- [Title of wiki page](#title-of-wiki-page)
+  - [Author](#author)
+  - [Date](#date)
+  - [Prerequisite](#prerequisite)
+  - [Some Content](#some-content)
+  - [more Content](#more-content)
+    - [Sources](#sources)
 <!-- TOC -->
+
 ## Some Content
 
 ## more Content