OSDN Git Service

Make it easy to install the tools to build the docs.
authorSimon Forman <sforman@hushmail.com>
Sun, 26 Apr 2020 02:12:25 +0000 (19:12 -0700)
committerSimon Forman <sforman@hushmail.com>
Sun, 26 Apr 2020 02:12:25 +0000 (19:12 -0700)
README
setup.py

diff --git a/README b/README
index 156b418..3c65c15 100644 (file)
--- 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
 
index 7eaadb3..d089560 100755 (executable)
--- a/setup.py
+++ b/setup.py
@@ -47,5 +47,12 @@ setup(
        install_requires=[
                'dulwich',
                'future',
-               ]
+               ],
+    extras_require={
+        "build-docs":  [
+                       "sphinx",
+                       "ipython",
+                       "nbconvert",
+                       ],
+           }
        )