Initial Documentation

.github/workflows/create-documentation.yaml

@@ -0,0 +1,41 @@
+name: Build Sphinx Documentation
+
+on:
+  push:
+    branches:
+      - main  # You can change this to whatever branch you want to trigger the build
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        working-directory: xembody
+
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.8.18'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .[docs]
+
+    - name: Build Documentation
+      run: |
+        make -C docs/ html
+
+    - name: Upload Documentation Artifacts
+      uses: actions/upload-artifact@v2
+      with:
+        name: docs
+        path: docs/build/html

xembody/README.md

@@ -0,0 +1,16 @@
+# xembody package
+
+This repository contains the official implementation of Mirage, and a benchmarking platform for cross-embodiment research.
+
+## Installation
+
+## Usage
+
+## Citation
+If you utilized the benchmark, please consider citing
+```
+TODO: Add link to ArXiv / publication
+```
+
+## Contributing
+Feel free to raise any concerns and bugs through the [issue]() portal, and submit PR with your own edits. Please reach out if some abstractions of features do not meet your needs, we are very eager to help with implementation.

xembody/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

xembody/docs/build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 6b94b17b1055196dbdf770cdf563fcc7
+tags: 645f666f9bcd5a90fca523b33c5a78b7