From f13d572304767348da5a3a55a63193b77e5bd5ef Mon Sep 17 00:00:00 2001 From: Simon Forman Date: Sat, 25 Apr 2020 19:12:25 -0700 Subject: [PATCH] Make it easy to install the tools to build the docs. --- README | 5 +++++ setup.py | 9 ++++++++- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/README b/README index 156b418..3c65c15 100644 --- a/README +++ b/README @@ -82,6 +82,11 @@ a makefile that uses nbconvert to generate ReST files from some of the notebooks, copies those to the sphinx source dir, then builds the HTML output using sphinx. +Get the dependencies for (re)building the docs: + + pip install Thun[build-docs] + make docs + ยง.4 Basics of Joy diff --git a/setup.py b/setup.py index 7eaadb3..d089560 100755 --- a/setup.py +++ b/setup.py @@ -47,5 +47,12 @@ setup( install_requires=[ 'dulwich', 'future', - ] + ], + extras_require={ + "build-docs": [ + "sphinx", + "ipython", + "nbconvert", + ], + } )