update readme (#276)

* update readme

.github/workflows/CompatHelper.yml

@@ -18,7 +18,7 @@ jobs:
       - name: "Run CompatHelper"
         run: |
           import CompatHelper
-          CompatHelper.main(; subdirs = ["", "src/ReinforcementLearningBase", "src/ReinforcementLearningCore", "src/ReinforcementLearningEnvironments", "src/ReinforcementLearningZoo"])
+          CompatHelper.main(; subdirs = ["", "src/ReinforcementLearningBase", "src/ReinforcementLearningCore", "src/ReinforcementLearningEnvironments", "src/ReinforcementLearningZoo", "src/ReinforcementLearningExperiments"])
         shell: julia --color=yes {0}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/ci.yml

@@ -52,8 +52,53 @@ jobs:
             Pkg.develop(path="src/ReinforcementLearningEnvironments")
             Pkg.develop(path="src/ReinforcementLearningZoo")
             Pkg.develop(path=".")
+            Pkg.develop(path="src/ReinforcementLearningExperiments")
             Pkg.test("ReinforcementLearningBase")
             Pkg.test("ReinforcementLearningCore")
             Pkg.test("ReinforcementLearningEnvironments")
             Pkg.test("ReinforcementLearningZoo")
-            Pkg.test("ReinforcementLearning")'
+            Pkg.test("ReinforcementLearning")
+            Pkg.test("ReinforcementLearningExperiments")'
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: '1'
+      - name: Build homepage
+        run: |
+          cd docs/homepage
+          julia --project --color=yes -e '
+            using Pkg; Pkg.instantiate();
+            using NodeJS; run(`$(npm_cmd()) install highlight.js`);
+            using Franklin;
+            optimize()' > build.log
+
+    # - name: Make sure homepage is generated without error
+    #   run: |
+    #     if grep -1 "Franklin Warning" build.log; then
+    #       echo "Franklin reported a warning"
+    #       exit 1
+    #     else
+    #       echo "Franklin did not report a warning"
+    #     fi
+
+      - name: Build docs
+        run: |
+          cd docs
+          julia --project --color=yes -e '
+            using Pkg; Pkg.instantiate();
+            include("make.jl")'
+          mv build homepage/__site/docs
+
+      - name: Deploy to the main repo
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' }}
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          external_repository: JuliaReinforcementLearning/JuliaReinforcementLearning.github.io
+          force_orphan: true
+          publish_branch: master
+          publish_dir: ./docs/homepage/__site

.gitignore

@@ -21,8 +21,8 @@ deps/usr/
 deps/src/
 
 # Build artifacts for creating documentation generated by the Documenter package
-docs/manual/build/
-docs/manual/src/index.md
+docs/build/
+docs/src/index.md
 docs/homepage/__site
 
 # File generated by Pkg, the package manager, based on a corresponding Project.toml
@@ -31,7 +31,7 @@ docs/homepage/__site
 # environment.
 Manifest.toml
 !docs/homepage/Manifest.toml
-!docs/manual/Manifest.toml
+!docs/Manifest.toml
 
 .vscode/*
 

NEWS.md

@@ -0,0 +1,30 @@
+# ReinforcementLearning.jl Release Notes
+
+## [email protected]
+
+### ReinforcementLearningBase.jl
+
+No change.
+
+### ReinforcementLearningCore.jl
+
+#### v0.8.0
+
+- Removed `ResizeImage` preprocessor to reduce the dependency of `ImageTransformations`. 
+- Show unicode plot at the end of an experiment in the `TotalRewardPerEpisode` hook.
+
+### ReinforcementLearningZoo.jl
+
+#### v0.4.0
+
+- Moved all the experiments into a new package `ReinforcementLearningExperiments.jl`. The related dependencies are also removed (`BSON.jl`, `StableRNGs.jl`, `TensorBoardLogger.jl`).
+
+### ReinforcementLearningEnvironments.jl
+
+#### v0.6.0
+
+- Set `AcrobotEnv` into lazy loading to reduce the dependency of `OrdinaryDiffEq`.
+
+### ReinforcementLearningExperiments.jl
+
+#### v0.1.0

Project.toml

@@ -13,10 +13,10 @@ ReinforcementLearningZoo = "d607f57d-ee1e-4ba7-bcf2-7734c1e31854"
 [compat]
 Reexport = "0.2, 1"
 ReinforcementLearningBase = "0.9"
-ReinforcementLearningCore = "0.7"
+ReinforcementLearningCore = "0.8"
 ReinforcementLearningEnvironments = "0.6"
-ReinforcementLearningZoo = "0.3"
-julia = "1.4"
+ReinforcementLearningZoo = "0.4"
+julia = "1.6"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"