Website development

.github/workflows/CD.yml

@@ -28,9 +28,12 @@ jobs:
         uses: TriPSs/conventional-changelog-action@v3
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
-          output-file: false
+          input-file: CHANGELOG.md
+          output-file: CHANGELOG.md
           fallback-version: ${{ env.NAVIX_VERSION }}
-          skip-commit: true
+          skip-commit: false
+          skip-tag: true
+
 
       - name: Create Release
         uses: ncipollo/release-action@v1
@@ -56,3 +59,20 @@ jobs:
         with:
           verbose: true
           password: ${{ secrets.PYPI_API_KEY }}
+
+  deploy-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v2
+        with:
+          python-version: "3.10"
+      - name: Setup navix
+        run: |
+          pip install . -v
+      - name: Build docs
+        run: |
+          mkdocs build
+      - name: Deploy docs
+        run: |
+          mkdocs gh-deploy

README.md

@@ -7,7 +7,7 @@
 ![PyPI version](https://img.shields.io/pypi/v/navix?label=PyPI&color=%230099ab)
 <!-- [![arXiv](https://img.shields.io/badge/arXiv-1234.56789-b31b1b.svg?style=flat)](https://arxiv.org/abs/1234.56789) -->
 
-**[Quickstart](#what-is-navix)** | **[Installation](#installation)** | **[Examples](#examples)** | **[The JAX ecosystem](#jax-ecosystem-for-rl)** | **[Contribute](#join-us)** | **[Cite](#cite)**
+**[Quickstart](#what-is-navix)** | **[Install](#installation)** | **[Examples](#examples)** | **[Docs](https://navix.readthedocs.io)** | **[The JAX ecosystem](#jax-ecosystem-for-rl)** | **[Contribute](#join-us)** | **[Cite](#cite)**
 
 </div>
 

docs/assets/stylesheets/extra.css

@@ -1,3 +1,23 @@
+@font-face {
+    font-family: 'Sage';
+    src: url('../fonts/sage-bold.woff2') format('woff');
+}
+
+@font-face {
+    font-family: 'Sherpa';
+    src: url('../fonts/sherpa.woff2') format('woff');
+}
+
+/* h1 {
+    font-family: 'Sage', sans-serif !important;
+    font-size: 44px !important;
+    color: #000 !important;
+}
+
+:root {
+    --md-text-font: "Sherpa";
+} */
+
 .md-header__button.md-logo {
     margin-bottom: 0;
     padding-bottom: 0;
@@ -8,6 +28,14 @@
     height: 3rem !important;
 }
 
+.no-bottom-margin {
+    margin-bottom: 0 !important;
+}
+
+.maiusc {
+    text-transform: uppercase;
+}
+
 .center {
     display: block;
     margin-left: auto;

docs/changelog.md

@@ -0,0 +1 @@
+--8<-- "CHANGELOG.md"

docs/examples/ppo.ipynb

@@ -4,7 +4,7 @@
             "cell_type": "markdown",
             "metadata": {},
             "source": [
-                "# NAVIX + PPO\n",
+                "# Training a PPO agent\n",
                 "\n",
                 "This tutorial demonstrates how to set up and run an experiment using NAVIX with a PPO (Proximal Policy Optimization) agent. We will go through the steps of defining the configuration, creating an environment, initializing the agent, and running the experiment."
             ]

docs/home/index.md → docs/index.md

@@ -1,8 +1,5 @@
-# NAVIX
-
-*Fast, fully jittable Minigrid reimplemented in JAX*
-<br>
-<br>
+<p class="maiusc">A <b>fast</b>, fully <b>jittable</b> MiniGrid reimplemented in JAX</p>
+<h1 class="no-bottom-margin">Welcome to <b>NAVIX</b>!</h1>
 
 
 **NAVIX** is a reimplementation of the [MiniGrid](https://minigrid.farama.org/) environment suite in JAX, and leverages JAX’s intermediate language representation to migrate the computation to different accelerators, such as GPUs and TPUs.
@@ -11,8 +8,9 @@ NAVIX is designed to be a drop-in replacement for the original MiniGrid environm
 Experiments that took **1 week**, now take **15 minutes**.
 
 A `navix.Environment` is a `flax.struct.PyTreeNode` and supports `jax.vmap`, `jax.jit`, `jax.grad`, and all the other JAX's transformations.
-See some examples [here](../examples/getting_started.ipynb).
+See some examples [here](examples/getting_started.ipynb).
 
+<br>
 Most of the MiniGrid environments are supported, and the API is designed to be as close as possible to the original MiniGrid API.
 However, some features might be missing, or the API might be slightly different.
 If you find so, please [open an issue](https://github.com/epignatelli/navix/issues/new) or a [pull request](https://github.com/epignatelli/navix/pulls), contributions are welcome!
@@ -26,4 +24,4 @@ Thanks to JAX's backend, NAVIX offers:
 - Full automatic differentiation: NAVIX can compute gradients of the environment with respect to the agent's actions.
 
 
-[Get started with NAVIX](../examples/getting_started.ipynb){ .md-button .md-button--primary}
+[Get started with NAVIX](examples/getting_started.ipynb){ .md-button .md-button--primary}

mkdocs.yml

@@ -13,7 +13,7 @@ watch:
 
 nav:
   - Home:
-      - Welcome: home/index.md
+      - Welcome: index.md
       - Environments: home/environments.md
   - Quickstart:
       - "Getting started": examples/getting_started.ipynb
@@ -23,7 +23,7 @@ nav:
   - Becnhmarks: benchmarks/index.md
   - API:
       - api/index.md
-  - Changelog: changelog/index.md
+  - Changelog: changelog.md
 
 # Customization
 extra:
@@ -49,6 +49,7 @@ extra_javascript:
 theme:
   name: "material"
   logo: assets/images/navix_logo.png
+  font: "Sherpa"
 
   features:
     - announce.dismiss

navix/_version.py

@@ -18,5 +18,5 @@
 # under the License.
 
 
-__version__ = "0.6.8"
+__version__ = "0.6.9"
 __version_info__ = tuple(int(i) for i in __version__.split(".") if i.isdigit())