Skip to content

Commit

Permalink
Separate the dev and docs requirements (#708)
Browse files Browse the repository at this point in the history
* Separate the `dev` and `docs` requirements

Running into trouble installing the custom sphinx packages from `git` in CPU CI, so this would help us get the `dev` dependencies without trying to install `docs` dependencies we don't need in that environment.

* Remove building the docs from the Tensorflow tests

This appears to already be covered by the Github Actions for the docs preview and scheduled rebuild, but is causing issues running the tests for this repo in other Merlin libraries (e.g. `core`.)
  • Loading branch information
karlhigley authored Sep 2, 2022
1 parent 53488e6 commit 5a345d9
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 20 deletions.
11 changes: 0 additions & 11 deletions .github/workflows/tensorflow.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,17 +55,6 @@ jobs:
with:
name: dist
path: dist
# Build the documentation, TODO: SPHINXOPTS="-W -q"
- name: Make HTML
run: |
make -C docs html
- name: Upload HTML
uses: actions/upload-artifact@v2
with:
name: html-build-artifact
path: docs/build/html
if-no-files-found: error
retention-days: 1
- name: Store PR information
run: |
mkdir ./pr
Expand Down
9 changes: 0 additions & 9 deletions requirements/dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,11 @@ flake8
interrogate==1.5.0
isort
mypy
Sphinx==3.5.4
jinja2<3.1
jupyter
markupsafe==2.0.1
sphinx_rtd_theme
sklearn
natsort==8.1.0
tensorflow-metadata
tensorflow-ranking>=0.4
testbook
sphinx-external-toc==0.2.4
myst-nb==0.13.2
linkify-it-py==1.0.3
sphinx-multiversion@git+https://github.com/mikemckiernan/sphinx-multiversion.git
sphinxcontrib-copydirs@git+https://github.com/mikemckiernan/sphinxcontrib-copydirs.git
fiddle
wandb
11 changes: 11 additions & 0 deletions requirements/docs.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
attrs==21.4.0
Jinja2<3.1
linkify-it-py==1.0.3
myst-nb==0.13.2
natsort==8.1.0
recommonmark==0.7.1
sphinx_rtd_theme==1.0.0
sphinx-external-toc==0.2.4
sphinx-multiversion@git+https://github.com/mikemckiernan/sphinx-multiversion.git
Sphinx==3.5.4
sphinxcontrib-copydirs@git+https://github.com/mikemckiernan/sphinxcontrib-copydirs.git
3 changes: 3 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@ def read_requirements(filename):


_dev = read_requirements("requirements/dev.txt")
_docs = read_requirements("requirements/docs.txt")
_nvt = read_requirements("requirements/nvtabular.txt")

requirements = {
"base": read_requirements("requirements/base.txt"),
"tensorflow": read_requirements("requirements/tensorflow.txt"),
Expand All @@ -49,6 +51,7 @@ def read_requirements(filename):
"xgboost": read_requirements("requirements/xgboost.txt"),
"nvtabular": _nvt,
"dev": _dev,
"docs": _docs,
}
dev_requirements = {
"tensorflow-dev": requirements["tensorflow"] + _dev + _nvt,
Expand Down

0 comments on commit 5a345d9

Please sign in to comment.