Merge pull request #72 from epignatelli/docs

Docs

.github/workflows/CI.yml

@@ -62,3 +62,25 @@ jobs:
           issue: ${{ github.event.pull_request.number }}
           message: ${{ env.MESSAGE }}
           repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+  Check-next-version:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+      - name: Get version from file
+        run: |
+          VERSION_FILE="navix/_version.py"
+          NAVIX_VERSION="$(cat navix/_version.py | grep '__version__ = ' |  cut -d'=' -f2 | sed 's,\",,g' | sed "s,\',,g" | sed 's, ,,g')"
+          echo "Current version is:"
+          echo "$NAVIX_VERSION"
+          echo "NAVIX_VERSION=$NAVIX_VERSION" >> $GITHUB_ENV
+      - name: Check that git tag does not exist
+        run: |
+          NAVIX_VERSION=${{ env.NAVIX_VERSION }}
+          git fetch --tags
+          if  [ $(git tag -l "$NAVIX_VERSION") ]; then
+            echo "Tag $NAVIX_VERSION already exists. Please update the version in navix/_version.py file."
+            exit 1
+          fi
+          echo "Tag $NAVIX_VERSION will be the deployed version."

README.md

@@ -5,6 +5,7 @@
 [![CI](https://github.com/epignatelli/navix/actions/workflows/CI.yml/badge.svg)](https://github.com/epignatelli/navix/actions/workflows/CI.yml)
 [![CD](https://github.com/epignatelli/navix/actions/workflows/CD.yml/badge.svg)](https://github.com/epignatelli/navix/actions/workflows/CD.yml)
 ![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)**
 
@@ -154,6 +155,7 @@ NAVIX is not alone and part of an ecosystem of JAX-powered modules for RL. Check
   - [Rejax](https://github.com/keraJLi/rejax): a suite of diverse agents, among which, DDPG, DQN, PPO, SAC, TD3
   - [Stoix](https://github.com/EdanToledo/Stoix): useful implementations of popular single-agent RL algorithms in JAX
   - [JAX-CORL](https://github.com/nissymori/JAX-CORL): lean single-file implementations of offline RL algorithms with solid performance reports
+  - [Dopamine](https://github.com/google/dopamine): a research framework for fast prototyping of reinforcement learning algorithms
 
 
 ## Join Us!

docs/api/index.md

@@ -0,0 +1 @@
+**Coming soon**

docs/assets/macros/macros.py

@@ -0,0 +1,3 @@
+from plumkdocs import define_env
+
+__all__ = ['define_env']

docs/assets/stylesheets/extra.css

@@ -0,0 +1,140 @@
+.md-header__button.md-logo {
+    margin-bottom: 0;
+    padding-bottom: 0;
+}
+
+.md-header__button.md-logo img,
+.md-header__button.md-logo svg {
+    height: 3rem !important;
+}
+
+.center {
+    display: block;
+    margin-left: auto;
+    margin-right: auto;
+}
+
+.doc-attribute {
+    border-top: 1px solid #ccc;
+}
+
+.doc-method {
+    border-top: 1px solid #ccc;
+}
+
+.doc-function {
+    border-top: 1px solid #ccc;
+}
+
+.doc-class {
+    border-top: 5px solid var(--md-code-bg-color);
+}
+
+/* Remove the `In` and `Out` block in rendered Jupyter notebooks */
+.md-container .jp-Cell-outputWrapper .jp-OutputPrompt.jp-OutputArea-prompt,
+.md-container .jp-Cell-inputWrapper .jp-InputPrompt.jp-InputArea-prompt {
+    display: none !important;
+}
+
+/* Fix /page#foo going to the top of the viewport and being hidden by the navbar */
+html {
+    scroll-padding-top: 50px;
+}
+
+/* Emphasise sections of nav on left hand side */
+nav.md-nav {
+    padding-left: 5px;
+}
+
+nav.md-nav--secondary {
+    border-left: revert !important;
+}
+
+.md-nav__title {
+    font-size: 0.9rem;
+}
+
+.md-nav__item--section>.md-nav__link {
+    font-size: 0.9rem;
+}
+
+/* More space at the bottom of the page */
+
+.md-main__inner {
+    margin-bottom: 1.5rem;
+}
+
+
+/* Change font sizes */
+html {
+    /* Decrease font size for overall webpage
+       Down from 137.5% which is the Material default */
+    font-size: 110%;
+}
+
+.md-typeset .admonition {
+    /* Increase font size in admonitions */
+    font-size: 100% !important;
+}
+
+.md-typeset details {
+    /* Increase font size in details */
+    font-size: 100% !important;
+}
+
+.md-typeset h1 {
+    font-size: 1.6rem;
+}
+
+.md-typeset h2 {
+    font-size: 1.5rem;
+}
+
+.md-typeset h3 {
+    font-size: 1.3rem;
+}
+
+.md-typeset h4 {
+    font-size: 1.1rem;
+}
+
+.md-typeset h5 {
+    font-size: 0.9rem;
+}
+
+.md-typeset h6 {
+    font-size: 0.8rem;
+}
+
+
+/* Highlight functions, classes etc. type signatures. Really helps to make clear where
+   one item ends and another begins. */
+
+[data-md-color-scheme="default"] {
+    --doc-heading-color: #DDD;
+    --doc-heading-border-color: #CCC;
+    --doc-heading-color-alt: #F0F0F0;
+}
+
+[data-md-color-scheme="slate"] {
+    --doc-heading-color: rgb(25, 25, 33);
+    --doc-heading-border-color: rgb(25, 25, 33);
+    --doc-heading-color-alt: rgb(33, 33, 44);
+    --md-code-bg-color: rgb(38, 38, 50);
+}
+
+h4.doc-heading {
+    /* NOT var(--md-code-bg-color) as that's not visually distinct from other code blocks.*/
+    background-color: var(--doc-heading-color);
+    border: solid var(--doc-heading-border-color);
+    border-width: 1.5pt;
+    border-radius: 2pt;
+    padding: 0pt 5pt 2pt 5pt;
+}
+
+h5.doc-heading,
+h6.heading {
+    background-color: var(--doc-heading-color-alt);
+    border-radius: 2pt;
+    padding: 0pt 5pt 2pt 5pt;
+}

docs/benchmarks/index.md

@@ -0,0 +1 @@
+**Coming soon**

docs/changelog/index.md

@@ -0,0 +1 @@
+**Coming soon**