Permalink
Browse files
MNT: tests need matplotlib, doc/build needs pdoc3
- Loading branch information...
Showing
with
4 additions
and
3 deletions.
-
+1
−1
doc/README.md
-
+2
−2
doc/build.sh
-
+1
−0
setup.py
|
|
@@ -2,7 +2,7 @@ Backtesting.py Documentation |
|
|
|
============================ |
|
|
|
After installing documentation dependencies: |
|
|
|
|
|
|
|
pip install .[doc] |
|
|
|
pip install .[doc,test] |
|
|
|
|
|
|
|
build HTML documentation by running: |
|
|
|
|
|
|
|
|
|
@@ -4,7 +4,7 @@ IS_RELEASE=${TRAVIS_TAG+1} |
|
|
|
|
|
|
|
die () { echo "ERROR: $*" >&2; exit 2; } |
|
|
|
|
|
|
|
for cmd in pdoc \ |
|
|
|
for cmd in pdoc3 \ |
|
|
|
jupytext \ |
|
|
|
jupyter-nbconvert; do |
|
|
|
command -v "$cmd" >/dev/null || |
|
|
@@ -21,7 +21,7 @@ echo |
|
|
|
mkdir -p "$BUILDROOT" |
|
|
|
rm -r "$BUILDROOT" 2>/dev/null || true |
|
|
|
pushd "$DOCROOT/.." >/dev/null |
|
|
|
pdoc --html --html-no-source \ |
|
|
|
pdoc3 --html --html-no-source \ |
|
|
|
${IS_RELEASE+--template-dir "$DOCROOT/pdoc_template"} \ |
|
|
|
--html-dir "$BUILDROOT" \ |
|
|
|
backtesting |
|
|
|
|
|
@@ -45,6 +45,7 @@ |
|
|
|
], |
|
|
|
'test': [ |
|
|
|
'seaborn', |
|
|
|
'matplotlib', |
|
|
|
], |
|
|
|
'dev': [ |
|
|
|
'flake8', |
|
|
|
0 comments on commit
74f0f9b