Changed to material mkdocs theme. Minor doc updates. (#5835)

miguelalonsojr · web-flow · commit 93d3a51439f1 · 2022-12-02T16:44:59.000-05:00
* Changed to material mkdocs theme. Minor doc updates.

* Updated colors and home banner.
diff --git a/docs/Installation.md b/docs/Installation.md
@@ -18,7 +18,7 @@ The ML-Agents Toolkit contains several components:
     a Unity scene. It is a foundational layer that facilitates data messaging
     between Unity scene and the Python machine learning algorithms.
     Consequently, `mlagents` depends on `mlagents_envs`.
-- Unity [Project](../Project/) that contains several
+- Unity [Project](https://github.com/Unity-Technologies/ml-agents/tree/main/Project/) that contains several
   [example environments](Learning-Environment-Examples.md) that highlight the
   various features of the toolkit to help you get started.
 
@@ -101,13 +101,13 @@ project by:
 1. Select the `package.json` file.
 
 <p align="center">
-  <img src="images/unity_package_manager_window.png"
+  <img src="../images/unity_package_manager_window.png"
        alt="Unity Package Manager Window"
-       height="300"
+       height="150"
        border="10" />
-  <img src="images/unity_package_json.png"
+  <img src="../images/unity_package_json.png"
      alt="package.json"
-     height="300"
+     height="150"
      border="10" />
 </p>
 
diff --git a/docs/Learning-Environment-Examples.md b/docs/Learning-Environment-Examples.md
@@ -1,6 +1,6 @@
 # Example Learning Environments
 
-<img src="images/example-envs.png" align="middle" width="3000"/>
+<img src="../images/example-envs.png" align="middle" width="3000"/>
 
 The Unity ML-Agents Toolkit includes an expanding set of example environments
 that highlight the various features of the toolkit. These environments can also
diff --git a/docs/Limitations.md b/docs/Limitations.md
@@ -2,6 +2,6 @@
 
 See the package-specific Limitations pages:
 
-- [`com.unity.mlagents` Unity package](https://docs.unity3d.com/Packages/com.unity.ml-agents@2.1/manual/index.html#known-limitations)
-- [`mlagents` Python package](ML-Agents-README.md)
-- [`mlagents_envs` Python package](../ml-agents-envs/README.md#limitations)
+- [`com.unity.mlagents` Unity package](https://docs.unity3d.com/Packages/com.unity.ml-agents@2.3/manual/index.html#known-limitations)
+- [`mlagents` Python package](../ml-agents/)
+- [`mlagents_envs` Python package](../ml-agents-envs/)
diff --git a/docs/Readme.md b/docs/Readme.md
@@ -29,6 +29,7 @@ developer communities.
 - Support for training single-agent, multi-agent cooperative, and multi-agent
   competitive scenarios via several Deep Reinforcement Learning algorithms (PPO, SAC, MA-POCA, self-play).
 - Support for learning from demonstrations through two Imitation Learning algorithms (BC and GAIL).
+- Quickly and easily add your own [custom training algorithm](Python-Custom-Trainer-Plugin.md) and/or components.
 - Easily definable Curriculum Learning scenarios for complex tasks
 - Train robust agents using environment randomization
 - Flexible agent control with On Demand Decision Making
@@ -40,13 +41,15 @@ developer communities.
 - Wrap Unity learning environments as a [PettingZoo](Python-PettingZoo-API.md) environment
 
 See our [ML-Agents Overview](ML-Agents-Overview.md) page for detailed
-descriptions of all these features.
+descriptions of all these features. Or go straight to our [web docs](https://unity-technologies.github.io/ml-agents/).
 ## Releases & Documentation
 
 **Our latest, stable release is `Release 20`. Click
-[here](https://github.com/Unity-Technologies/ml-agents/tree/release_20_docs/docs/Readme.md)
+[here](Getting-Started.md)
 to get started with the latest release of ML-Agents.**
 
+**You can also check out our new [web docs](https://unity-technologies.github.io/ml-agents/)!**
+
 The table below lists all our releases, including our `main` branch which is
 under active development and may be unstable. A few helpful guidelines:
 - The [Versioning page](Versioning.md) overviews how we manage our GitHub
@@ -159,9 +162,8 @@ We have also published a series of blog posts that are relevant for ML-Agents:
 
 ### More from Unity
 
-- [Unity Simulation Pro](https://unity.com/products/unity-simulation-pro)
 - [Unity Robotics](https://github.com/Unity-Technologies/Unity-Robotics-Hub)
-- [Unity Computer Vision](https://unity.com/computer-vision)
+- [Unity Computer Vision](https://github.com/Unity-Technologies/com.unity.perception)
 
 ## Community and Feedback
 
diff --git a/docs/com.unity.ml-agents.extensions.md b/docs/com.unity.ml-agents.extensions.md
@@ -0,0 +1 @@
+{!../com.unity.ml-agents.extensions/Documentation~/com.unity.ml-agents.extensions.md!}
diff --git a/docs/extra.css b/docs/extra.css
@@ -1,3 +1,9 @@
 .wy-nav-top, .wy-side-nav-search {
     background: #439b47;
 }
+
+.md-typeset__scrollwrap {
+    margin: 1em -.8rem;
+    overflow-x: visible;
+    touch-action: auto;
+}
diff --git a/docs/images/unity-logo-black.png b/docs/images/unity-logo-black.png
diff --git a/docs/images/unity-logo.png b/docs/images/unity-logo.png
diff --git a/docs/index.md b/docs/index.md
@@ -1,2 +1,2 @@
-<img src="images/U_MachineLearningAgents_Logo_Black_RGB.png" align="middle" width="3000"/>
+<img src="images/image-banner.png" align="middle" width="3000"/>
 {!README.md!}
diff --git a/docs/ml-agents-envs.md b/docs/ml-agents-envs.md
@@ -0,0 +1 @@
+{!../ml-agents-envs/README.md!}
diff --git a/docs/ml-agents.md b/docs/ml-agents.md
@@ -0,0 +1 @@
+{!../ml-agents/README.md!}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -4,8 +4,8 @@ repo_url: https://github.com/Unity-Technologies/ml-agents
 edit_uri: edit/main/docs/
 site_description: The Unity Machine Learning Agents Toolkit (ML-Agents) is an open-source project that enables games and simulations to serve as environments for training intelligent agents.
 site_author: Unity Technologies
-copyright: com.unity.ml-agents copyright © 2017 Unity Technologies
-pages:
+copyright: com.unity.ml-agents copyright © 2017 - 2022 Unity Technologies
+nav:
 - Home: index.md
 - ML-Agents Overview: ML-Agents-Overview.md
 - Toolkit Documentation: ML-Agents-Toolkit-Documentation.md
@@ -21,13 +21,23 @@ pages:
     - Gym API Documentation: Python-Gym-API-Documentation.md
     - Petting Zoo Documentation: Python-PettingZoo-API-Documentation.md
     - LLAPI Documentation: Python-LLAPI-Documentation.md
+    - On/Off Policy Trainer: Python-On-Off-Policy-Trainer-Documentation.md
+- Tutorials:
+    - Custom Trainer Plugin: Tutorial-Custom-Trainer-Plugin.md
 - About:
     - FAQs: FAQ.md
     - Limitations: Limitations.md
     - Migrating: Migrating.md
     - Versioning: Versioning.md
-theme: readthedocs
-extra_css: [extra.css]
+theme:
+  name: material
+  logo: images/unity-logo.png
+  favicon: images/unity-logo-black.png
+  palette:
+    primary: blue
+    accent: light blue
+extra_css:
+  - extra.css
 markdown_extensions:
     - markdown_include.include:
         base_path: docs

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{!../com.unity.ml-agents.extensions/Documentation~/com.unity.ml-agents.extensions.md!}`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-<img src="images/U_MachineLearningAgents_Logo_Black_RGB.png" align="middle" width="3000"/>`
	`1`	`+<img src="images/image-banner.png" align="middle" width="3000"/>`
`2`	`2`	`{!README.md!}`