fix: docs workflow

.github/workflows/documentation.yml

@@ -0,0 +1,30 @@
+name: documentation
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+      - name: Install dependencies
+        run: |
+          pip install sphinx sphinx_rtd_theme myst_parser
+      - name: Sphinx build
+        run: |
+          sphinx-build docs/source docs/build
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: _build/
+          force_orphan: true

rtd/sim/world/WorldEntity.py

@@ -27,6 +27,7 @@ def construct_components(self, component_name: str, *component_args):
             # results in:
             # self.state = GenericEntityState(BoxObstacleInfo(), n_states=5)
         
+        
         Parameters
         ----------
         component_name : str
@@ -66,6 +67,7 @@ def reset_components(self):
             # equivalent to calling:
             # self.info.reset()
             # self.state.reset(n_states=5)
+            
              
         '''
         options = self.getoptions()
@@ -94,6 +96,7 @@ def get_componentOverrideOptions(components: dict) -> dict:
             # options["components"] = {"info": EmptyInfoState, "state": GenericEntityState}
             # options["component_options"] = {"state": {"n_states": 5}}
         
+        
         Parameters
         ----------
         components : dict