Skip to content

Commit

Permalink
Initial Documentation (#1)
Browse files Browse the repository at this point in the history
* Cleaned up some of the code

* Added benchmarking code to be more clear

* Added printing of parameters for a user

* Added initial README skeleton

* Updated docs

* Added sphinx docs workflow

* Added initial documentation

* Documentation created again

* Added new version of the docs

* Updated working directory

* Updated documentation
  • Loading branch information
KDharmarajanDev authored Feb 27, 2024
1 parent 96f7cfd commit 73d5987
Show file tree
Hide file tree
Showing 127 changed files with 14,882 additions and 89 deletions.
41 changes: 41 additions & 0 deletions .github/workflows/create-documentation.yaml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion mimicgen_environments
2 changes: 1 addition & 1 deletion robomimic
2 changes: 1 addition & 1 deletion robosuite
16 changes: 16 additions & 0 deletions xembody/README.md
Original file line number Diff line number Diff line change
@@ -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.
20 changes: 20 additions & 0 deletions xembody/docs/Makefile
Original file line number Diff line number Diff line change
@@ -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)
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added xembody/docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file not shown.
Binary file added xembody/docs/build/doctrees/index.doctree
Binary file not shown.
4 changes: 4 additions & 0 deletions xembody/docs/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -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
Loading

0 comments on commit 73d5987

Please sign in to comment.