From a7e13e74c9cfb7db0103ebf6df34df6f795b3d1b Mon Sep 17 00:00:00 2001 From: josiah_wong <84cremebrule@gmail.com> Date: Thu, 15 Dec 2022 02:38:32 -0800 Subject: [PATCH] prune docs and add necessary generation files --- LICENSE | 2 +- clean.sh | 4 - docs/dist/css/style.css | 1033 +++++++++++++++++++++++++++++++++++++++ docs/index.md | 6 + docs_extra/index.html | 43 ++ environment.yml | 32 -- mkdocs.yml | 92 ++++ 7 files changed, 1175 insertions(+), 37 deletions(-) delete mode 100755 clean.sh create mode 100644 docs/dist/css/style.css create mode 100644 docs/index.md create mode 100644 docs_extra/index.html delete mode 100644 environment.yml create mode 100644 mkdocs.yml diff --git a/LICENSE b/LICENSE index cd8da6ce4..3883c7d16 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2017 Stanford Vision and Learning Group +Copyright (c) 2023 Stanford Vision and Learning Group Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/clean.sh b/clean.sh deleted file mode 100755 index 53df35964..000000000 --- a/clean.sh +++ /dev/null @@ -1,4 +0,0 @@ -#!/bin/sh - -rm -rf build -rm -rf omnigibson/render/mesh_renderer/build/ diff --git a/docs/dist/css/style.css b/docs/dist/css/style.css new file mode 100644 index 000000000..d588504e3 --- /dev/null +++ b/docs/dist/css/style.css @@ -0,0 +1,1033 @@ +html{ + line-height:1.15; + -ms-text-size-adjust:100%; + -webkit-text-size-adjust:100% +} +body{ + margin:0 +} +article,aside,footer,header,nav,section{ + display:block +} +h1{ + font-size:2em; + margin:0.67em 0 +} +figcaption,figure,main{ + display:block +} +figure{ + margin:1em 40px +} +hr{ + box-sizing:content-box; + height:0; + overflow:visible +} +pre{ + font-family:monospace, monospace; + font-size:1em +} +a{ + background-color:transparent; + -webkit-text-decoration-skip:objects +} +abbr[title]{ + border-bottom:none; + text-decoration:underline; + -webkit-text-decoration:underline dotted; + text-decoration:underline dotted +} +b,strong{ + font-weight:inherit +} +b,strong{ + font-weight:bolder +} +code,kbd,samp{ + font-family:monospace, monospace; + font-size:1em +} +dfn{ + font-style:italic +} +mark{ + background-color:#ff0; + color:#000 +} +small{ + font-size:80% +} +sub,sup{ + font-size:75%; + line-height:0; + position:relative; + vertical-align:baseline +} +sub{ + bottom:-0.25em +} +sup{ + top:-0.5em +} +audio,video{ + display:inline-block +} +audio:not([controls]){ + display:none; + height:0 +} +img{ + border-style:none +} +svg:not(:root){ + overflow:hidden +} +button,input,optgroup,select,textarea{ + font-family:sans-serif; + font-size:100%; + line-height:1.15; + margin:0 +} +button,input{ + overflow:visible +} +button,select{ + text-transform:none +} +button,html [type="button"],[type="reset"],[type="submit"]{ + -webkit-appearance:button +} +button::-moz-focus-inner,[type="button"]::-moz-focus-inner,[type="reset"]::-moz-focus-inner,[type="submit"]::-moz-focus-inner{ + border-style:none; + padding:0 +} +button:-moz-focusring,[type="button"]:-moz-focusring,[type="reset"]:-moz-focusring,[type="submit"]:-moz-focusring{ + outline:1px dotted ButtonText +} +fieldset{ + padding:0.35em 0.75em 0.625em +} +legend{ + box-sizing:border-box; + color:inherit; + display:table; + max-width:100%; + padding:0; + white-space:normal +} +progress{ + display:inline-block; + vertical-align:baseline +} +textarea{ + overflow:auto +} +[type="checkbox"],[type="radio"]{ + box-sizing:border-box; + padding:0 +} +[type="number"]::-webkit-inner-spin-button,[type="number"]::-webkit-outer-spin-button{ + height:auto +} +[type="search"]{ + -webkit-appearance:textfield; + outline-offset:-2px +} +[type="search"]::-webkit-search-cancel-button,[type="search"]::-webkit-search-decoration{ + -webkit-appearance:none +} +::-webkit-file-upload-button{ + -webkit-appearance:button; + font:inherit +} +details,menu{ + display:block +} +summary{ + display:list-item +} +canvas{ + display:inline-block +} +template{ + display:none +} +[hidden]{ + display:none +} +html{ + box-sizing:border-box +} +*,*:before,*:after{ + box-sizing:inherit +} +body{ + /*background:#1D2026;*/ + /*-moz-osx-font-smoothing:grayscale;*/ + /*-webkit-font-smoothing:antialiased*/ +} +hr{ + border:0; + display:block; + height:1px; + background:#242830; + margin-top:24px; + margin-bottom:24px +} +ul,ol{ + margin-top:0; + margin-bottom:24px; + padding-left:24px +} +ul{ + list-style:disc +} +ol{ + list-style:decimal +} +li>ul,li>ol{ + margin-bottom:0 +} +dl{ + margin-top:0; + margin-bottom:24px +} +dt{ + font-weight:600 +} +dd{ + margin-left:24px; + margin-bottom:24px +} +img{ + height:auto; + max-width:100%; + vertical-align:middle +} +figure{ + margin:24px 0 +} +figcaption{ + font-size:16px; + line-height:24px; + padding:8px 0 +} +img,svg{ + display:block +} +table{ + border-collapse:collapse; + margin-bottom:24px; + width:100% +} +tr{ + border-bottom:1px solid #242830 +} +th{ + text-align:left +} +th,td{ + padding:10px 16px +} +th:first-child,td:first-child{ + padding-left:0 +} +th:last-child,td:last-child{ + padding-right:0 +} +html{ + font-size:20px; + line-height:30px +} +body{ + color:#8A94A7; + font-size:1rem +} +body,button,input,select,textarea{ + font-family:"IBM Plex Sans", sans-serif +} +a{ + color:#8A94A7; + text-decoration:underline +} +a:hover,a:active{ + outline:0; + text-decoration:none +} +h1,h2,h3,h4,h5,h6,.h1,.h2,.h3,.h4,.h5,.h6{ + clear:both; + color:#fff; + font-weight:600 +} +h1,.h1{ + font-size:38px; + line-height:48px; + letter-spacing:0px +} +@media (min-width: 641px){ + h1,.h1{ + font-size:44px; + line-height:54px; + letter-spacing:0px + } +} +h2,.h2{ + font-size:32px; + line-height:42px; + letter-spacing:0px +} +@media (min-width: 641px){ + h2,.h2{ + font-size:38px; + line-height:48px; + letter-spacing:0px + } +} +h3,.h3,blockquote{ + font-size:24px; + line-height:34px; + letter-spacing:0px +} +@media (min-width: 641px){ + h3,.h3,blockquote{ + font-size:32px; + line-height:42px; + letter-spacing:0px + } +} +h4,h5,h6,.h4,.h5,.h6{ + font-size:20px; + line-height:30px; + letter-spacing:-0.1px +} +@media (min-width: 641px){ + h4,h5,h6,.h4,.h5,.h6{ + font-size:24px; + line-height:34px; + letter-spacing:0px + } +} +@media (max-width: 640px){ + .h1-mobile{ + font-size:38px; + line-height:48px; + letter-spacing:0px + } + .h2-mobile{ + font-size:32px; + line-height:42px; + letter-spacing:0px + } + .h3-mobile{ + font-size:24px; + line-height:34px; + letter-spacing:0px + } + .h4-mobile,.h5-mobile,.h6-mobile{ + font-size:20px; + line-height:30px; + letter-spacing:-0.1px + } +} +.text-sm{ + font-size:18px; + line-height:28px; + letter-spacing:-0.1px +} +.text-xs{ + font-size:16px; + line-height:24px; + letter-spacing:-0.1px +} +h1,h2,.h1,.h2{ + margin-top:48px; + margin-bottom:16px +} +h3,.h3{ + margin-top:36px; + margin-bottom:12px +} +h4,h5,h6,.h4,.h5,.h6{ + margin-top:24px; + margin-bottom:4px +} +p{ + margin-top:0; + margin-bottom:24px +} +dfn,cite,em,i{ + font-style:italic +} +blockquote{ + color:#3B404C; + font-style:italic; + margin-top:24px; + margin-bottom:24px; + margin-left:24px +} +blockquote::before{ + content:"\201C" +} +blockquote::after{ + content:"\201D" +} +blockquote p{ + display:inline +} +address{ + color:#8A94A7; + border-width:1px 0; + border-style:solid; + border-color:#242830; + padding:24px 0; + margin:0 0 24px +} +pre,pre h1,pre h2,pre h3,pre h4,pre h5,pre h6,pre .h1,pre .h2,pre .h3,pre .h4,pre .h5,pre .h6{ + font-family:"Courier 10 Pitch", Courier, monospace +} +pre,code,kbd,tt,var{ + background:#1D2026 +} +pre{ + font-size:16px; + line-height:24px; + margin-bottom:1.6em; + max-width:100%; + overflow:auto; + padding:24px; + margin-top:24px; + margin-bottom:24px +} +code,kbd,tt,var{ + font-family:Monaco, Consolas, "Andale Mono", "DejaVu Sans Mono", monospace; + font-size:16px; + padding:2px 4px +} +abbr,acronym{ + cursor:help +} +mark,ins{ + text-decoration:none +} +small{ + font-size:18px; + line-height:28px; + letter-spacing:-0.1px +} +b,strong{ + font-weight:600 +} +button,input,select,textarea,label{ + font-size:20px; + line-height:30px +} +.container,.container-sm{ + width:100%; + margin:0 auto; + padding-left:16px; + padding-right:16px +} +@media (min-width: 481px){ + .container,.container-sm{ + padding-left:24px; + padding-right:24px + } +} +.container{ + max-width:1128px +} +.container-sm{ + max-width:848px +} +.container .container-sm{ + max-width:800px; + padding-left:0; + padding-right:0 +} +.screen-reader-text{ + clip:rect(1px, 1px, 1px, 1px); + position:absolute !important; + height:1px; + width:1px; + overflow:hidden; + word-wrap:normal !important +} +.screen-reader-text:focus{ + border-radius:2px; + box-shadow:0 0 2px 2px rgba(0,0,0,0.6); + clip:auto !important; + display:block; + font-size:14px; + letter-spacing:0px; + font-weight:600; + line-height:16px; + text-decoration:none; + text-transform:uppercase; + /*background-color:#1D2026;*/ + /*color:#0270D7 !important;*/ + border:none; + height:auto; + left:8px; + padding:16px 32px; + top:8px; + width:auto; + z-index:100000 +} +.list-reset{ + list-style:none; + padding:0 +} +.text-left{ + text-align:left +} +.text-center{ + text-align:center +} +.text-right{ + text-align:right +} +.text-primary{ + color:#0270D7 +} +.has-top-divider{ + position:relative +} +.has-top-divider::before{ + content:''; + position:absolute; + top:0; + left:0; + width:100%; + display:block; + height:1px; + background:#242830 +} +.has-bottom-divider{ + position:relative +} +.has-bottom-divider::after{ + content:''; + position:absolute; + bottom:0; + left:0; + width:100%; + display:block; + height:1px; + background:#242830 +} +.bottom{ + position: absolute; + bottom: 0; + left: 0; +} +.top{ + position: absolute; + top: 0; + left: 0; +} +.m-0{ + margin:0 +} +.mt-0{ + margin-top:0 +} +.mr-0{ + margin-right:0 +} +.mb-0{ + margin-bottom:0 +} +.ml-0{ + margin-left:0 +} +.m-8{ + margin:8px +} +.mt-8{ + margin-top:8px +} +.mr-8{ + margin-right:8px +} +.mb-8{ + margin-bottom:8px +} +.ml-8{ + margin-left:8px +} +.m-16{ + margin:16px +} +.mt-16{ + margin-top:16px +} +.mr-16{ + margin-right:16px +} +.mb-16{ + margin-bottom:16px +} +.ml-16{ + margin-left:16px +} +.m-24{ + margin:24px +} +.mt-24{ + margin-top:24px +} +.mr-24{ + margin-right:24px +} +.mb-24{ + margin-bottom:24px +} +.ml-24{ + margin-left:24px +} +.m-32{ + margin:32px +} +.mt-32{ + margin-top:32px +} +.mr-32{ + margin-right:32px +} +.mb-32{ + margin-bottom:32px +} +.ml-32{ + margin-left:32px +} +.m-40{ + margin:40px +} +.mt-40{ + margin-top:40px +} +.mr-40{ + margin-right:40px +} +.mb-40{ + margin-bottom:40px +} +.ml-40{ + margin-left:40px +} +.m-48{ + margin:48px +} +.mt-48{ + margin-top:48px +} +.mr-48{ + margin-right:48px +} +.mb-48{ + margin-bottom:48px +} +.ml-48{ + margin-left:48px +} +.m-56{ + margin:56px +} +.mt-56{ + margin-top:56px +} +.mr-56{ + margin-right:56px +} +.mb-56{ + margin-bottom:56px +} +.ml-56{ + margin-left:56px +} +.m-64{ + margin:64px +} +.mt-64{ + margin-top:64px +} +.mr-64{ + margin-right:64px +} +.mb-64{ + margin-bottom:64px +} +.ml-64{ + margin-left:64px +} +.p-0{ + padding:0 +} +.pt-0{ + padding-top:0 +} +.pr-0{ + padding-right:0 +} +.pb-0{ + padding-bottom:0 +} +.pl-0{ + padding-left:0 +} +.p-8{ + padding:8px +} +.pt-8{ + padding-top:8px +} +.pr-8{ + padding-right:8px +} +.pb-8{ + padding-bottom:8px +} +.pl-8{ + padding-left:8px +} +.p-16{ + padding:16px +} +.pt-16{ + padding-top:16px +} +.pr-16{ + padding-right:16px +} +.pb-16{ + padding-bottom:16px +} +.pl-16{ + padding-left:16px +} +.p-24{ + padding:24px +} +.pt-24{ + padding-top:24px +} +.pr-24{ + padding-right:24px +} +.pb-24{ + padding-bottom:24px +} +.pl-24{ + padding-left:24px +} +.p-32{ + padding:32px +} +.pt-32{ + padding-top:32px +} +.pr-32{ + padding-right:32px +} +.pb-32{ + padding-bottom:32px +} +.pl-32{ + padding-left:32px +} +.p-40{ + padding:40px +} +.pt-40{ + padding-top:40px +} +.pr-40{ + padding-right:40px +} +.pb-40{ + padding-bottom:40px +} +.pl-40{ + padding-left:40px +} +.p-48{ + padding:48px +} +.pt-48{ + padding-top:48px +} +.pr-48{ + padding-right:48px +} +.pb-48{ + padding-bottom:48px +} +.pl-48{ + padding-left:48px +} +.p-56{ + padding:56px +} +.pt-56{ + padding-top:56px +} +.pr-56{ + padding-right:56px +} +.pb-56{ + padding-bottom:56px +} +.pl-56{ + padding-left:56px +} +.p-64{ + padding:64px +} +.pt-64{ + padding-top:64px +} +.pr-64{ + padding-right:64px +} +.pb-64{ + padding-bottom:64px +} +.pl-64{ + padding-left:64px +} +.sr .has-animations .is-revealing{ + visibility:hidden +} +.has-animations .anime-element{ + visibility:hidden +} +.anime-ready .has-animations .anime-element{ + visibility:visible +} +.input,.textarea{ + background-color:#fff; + border-width:1px; + border-style:solid; + border-color:#242830; + border-radius:2px; + color:#8A94A7; + max-width:100%; + width:100% +} +.input::-webkit-input-placeholder,.textarea::-webkit-input-placeholder{ + color:#3B404C +} +.input:-ms-input-placeholder,.textarea:-ms-input-placeholder{ + color:#3B404C +} +.input::-ms-input-placeholder,.textarea::-ms-input-placeholder{ + color:#3B404C +} +.input::placeholder,.textarea::placeholder{ + color:#3B404C +} +.input::-ms-input-placeholder,.textarea::-ms-input-placeholder{ + color:#3B404C +} +.input:-ms-input-placeholder,.textarea:-ms-input-placeholder{ + color:#3B404C +} +.input:hover,.textarea:hover{ + border-color:#191c21 +} +.input:active,.input:focus,.textarea:active,.textarea:focus{ + outline:none; + border-color:#242830 +} +.input[disabled],.textarea[disabled]{ + cursor:not-allowed; + background-color:#1D2026; + border-color:#1D2026 +} +.input{ + -moz-appearance:none; + -webkit-appearance:none; + font-size:16px; + letter-spacing:-0.1px; + line-height:20px; + padding:13px 16px; + height:48px; + box-shadow:none +} +.input .inline-input{ + display:inline; + width:auto +} +.textarea{ + display:block; + min-width:100%; + resize:vertical +} +.textarea .inline-textarea{ + display:inline; + width:auto +} +.field-grouped>.control:not(:last-child){ + margin-bottom:8px +} +@media (min-width: 641px){ + .field-grouped{ + display:flex + } + .field-grouped>.control{ + flex-shrink:0 + } + .field-grouped>.control.control-expanded{ + flex-grow:1; + flex-shrink:1 + } + .field-grouped>.control:not(:last-child){ + margin-bottom:0; + margin-right:8px + } +} +.button{ + display:inline-flex; + font-size:14px; + letter-spacing:0px; + font-weight:600; + line-height:16px; + text-decoration:none !important; + text-transform:uppercase; + background-color:#242830; + color:#fff !important; + border:none; + border-radius:2px; + cursor:pointer; + justify-content:center; + padding:16px 32px; + height:48px; + text-align:center; + white-space:nowrap +} +.button:hover{ + background:#262a33 +} +.button:active{ + outline:0 +} +.button::before{ + border-radius:2px +} +.button-sm{ + padding:8px 24px; + height:32px +} +.button-primary{ + background:#8c1515; + background:linear-gradient(65deg, #8a0f0f 0, #8a2727 100%) +} +.button-primary:hover{ + background:#b32727; + background:linear-gradient(65deg, #b51d1d 0, #b83b3b 100%) +} +.button-block{ + display:flex +} +.button-block{ + display:flex; + width:100% +} +@media (max-width: 640px){ + .button-wide-mobile{ + width:100%; + max-width:280px + } +} +.site-header{ + padding:24px 0 +} +.site-header-inner{ + position:relative; + display:flex; + justify-content:space-between; + align-items:center +} +.header-links{ + display:inline-flex +} +.header-links li{ + display:inline-flex +} +.header-links a:not(.button){ + font-size:16px; + line-height:24px; + letter-spacing:-0.1px; + font-weight:600; + color:#8A94A7; + text-transform:uppercase; + text-decoration:none; + line-height:16px; + padding:8px 24px +} +@media (min-width: 641px) { + .site-header { + position: relative + } + + .site-header::before { + content: ''; + position: absolute; + top: 0; + left: 0; + width: 100%; + height: 1200px; + background-image: url("../../../docs/assets/splash_no_logo.png"), linear-gradient(rgba(0, 0, 0, 0.5), rgba(0, 0, 0, 1)); + mask-image: linear-gradient(to right, rgba(0, 0, 0, 1.0) 50%, transparent 100%); + background-size: contain; + background-repeat: no-repeat; + } + + .hero { + text-align: left; + padding-top: 48px; + padding-bottom: 88px + } + + .hero-copy { + position: relative; + z-index: 1 + } + + @media (min-width: 641px) { + .hero { + text-align: left; + padding-top: 64px; + padding-bottom: 88px + } + + .hero-inner { + display: flex; + justify-content: space-between; + align-items: center + } + + .hero-copy { + padding-right: 64px; + min-width: 552px; + width: 552px + } + + .hero-cta { + margin: 0 + } + + .hero-cta .button { + min-width: 170px + } + + .hero-cta .button:first-child { + margin-right: 16px + } + + .hero-figure svg { + width: auto + } + } +} diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 000000000..b5173abec --- /dev/null +++ b/docs/index.md @@ -0,0 +1,6 @@ +--- + +title: Title +template: index.html + +--- diff --git a/docs_extra/index.html b/docs_extra/index.html new file mode 100644 index 000000000..9b5c3c5ca --- /dev/null +++ b/docs_extra/index.html @@ -0,0 +1,43 @@ + + + + + + + OmniGibson + + + + + +
+
+
+
+
+

+ + Logo + +

+
+
+
+
+ +
+
+
+
+
+

OmniGibson

+

a platform for accelerating embodied AI research

+
Get StartedSource Code
+
+
+
+
+
+
+ + diff --git a/environment.yml b/environment.yml deleted file mode 100644 index 6c18ab086..000000000 --- a/environment.yml +++ /dev/null @@ -1,32 +0,0 @@ -name: ig3 -channels: - - conda-forge - - pytorch-nightly - - nvidia - - defaults -dependencies: - - addict=2.4.0 - - cudatoolkit=11.1 - - ipython - - matplotlib=3.1.3 - - networkx=2.5.1 - - pip=20.3.3 - - python=3.7 - - pytorch - - pyyaml - - requests=2.23.0 - - torchaudio - - torchvision - - transforms3d=0.3.1 - - trimesh=3.10.7 - - six=1.12.0 - - pip: - - gym==0.17.3 - - opencv-python==4.4.0.44 - - pillow==8.2.0 - - scipy==1.5.4 - - stable-baselines3==0.10.0 - - tensorboard==2.4.0 - - tensorboard-plugin-wit==1.7.0 - - tensorflow-estimator==2.3.0 - - tensorflow-gpu==2.3.1 diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 000000000..210618ae1 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,92 @@ +yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json + +site_name: OmniGibson Documentation +repo_name: StanfordVL/OmniGibson +repo_url: https://github.com/StanfordVL/OmniGibson +theme: + name: material + logo: assets/OmniGibson_logo.png + favicon: assets/OmniGibson_logo.png + icon: + repo: fontawesome/brands/git-alt + + features: + # - header.autohide + - navigation.tracking + - navigation.tabs + + extra: + homepage: https://behavior.stanford.edu + + custom_dir: docs_extra #solid #material/.overrides + + # color info + palette: + + # Palette toggle for light mode + - media: "(prefers-color-scheme: light)" + primary: white + accent: indigo + scheme: default + toggle: + icon: material/toggle-switch + name: Switch to dark mode + + # Palette toggle for dark mode + - media: "(prefers-color-scheme: dark)" + primary: blue grey + accent: indigo + scheme: slate + toggle: + icon: material/toggle-switch-off-outline + name: Switch to light mode + +extra_css: + - stylesheets/extra.css + +markdown_extensions: + - pymdownx.emoji: + emoji_index: !!python/name:materialx.emoji.twemoji + emoji_generator: !!python/name:materialx.emoji.to_svg + - admonition + - pymdownx.details + - pymdownx.superfences + - pymdownx.tabbed: + alternate_style: true + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.inlinehilite + - pymdownx.snippets: + base_path: docs + - pymdownx.tasklist: + custom_checkbox: true + - attr_list + - md_in_html + - attr_list + - md_in_html + +# extra plugins +plugins: + - search + - autorefs + - mkdocstrings: + handlers: + python: + paths: [omnigibson] + # - social + - gen-files: + scripts: + - docs/gen_ref_pages.py + - literate-nav: + nav_file: SUMMARY.md + - section-index + - offline + +nav: + - Home: index.md + - Getting Started: + # - getting_started/index.md + - Installation: getting_started/installation.md + - Quickstart: getting_started/quickstart.md + - Building Blocks: getting_started/building_blocks.md + - Code Reference: reference/ \ No newline at end of file