From 1ed15bf6ee482019e5985a893f1783abdb510d9b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=20D=C3=B6rr?= Date: Sat, 10 Apr 2021 14:04:37 +0200 Subject: [PATCH] Add package to install (#378) * Add package to install * Update docs packages installation command Co-authored-by: Antonin RAFFIN --- docs/README.md | 4 ++-- docs/misc/changelog.rst | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/README.md b/docs/README.md index 1427a79..169a5e3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,9 +6,9 @@ This folder contains documentation for the RL baselines. ### Build the Documentation #### Install Sphinx and Theme - +Execute this command in the project root: ``` -pip install sphinx sphinx-autobuild sphinx-rtd-theme +pip install -e .[docs] ``` #### Building the Docs diff --git a/docs/misc/changelog.rst b/docs/misc/changelog.rst index 6560975..3e69895 100644 --- a/docs/misc/changelog.rst +++ b/docs/misc/changelog.rst @@ -31,9 +31,9 @@ Documentation: - Added link to SuperSuit in projects (@justinkterry) - Fixed DQN example (thanks @ltbd78) - Clarify channel-first/channel-last recommendation +- Update sphinx environment installation instructions (@tom-doerr) - Clarify pip installation in Zsh (@tom-doerr) - Release 1.0 (2021-03-15) ------------------------