Skip to content

5883 review requirements-dev.txt, docs/requirements.txt#5888

Merged
wyli merged 2 commits intoProject-MONAI:devfrom
wyli:fixes-5883
Jan 23, 2023
Merged

5883 review requirements-dev.txt, docs/requirements.txt#5888
wyli merged 2 commits intoProject-MONAI:devfrom
wyli:fixes-5883

Conversation

@wyli
Copy link
Copy Markdown
Contributor

@wyli wyli commented Jan 23, 2023

Signed-off-by: Wenqi Li [email protected]

Fixes #5883

  • to run unit/integration tests, the developers should use runtests.sh
    which implements

    MONAI/runtests.sh

    Lines 130 to 133 in 2d0e021

    function install_deps {
    echo "Pip installing MONAI development dependencies and compile MONAI cpp extensions..."
    ${cmdPrefix}${PY_EXE} -m pip install -r requirements-dev.txt
    }

  • for read-the-docs builds, it automatically runs cd docs; make html:
    which installs docs/requirements.txt

    MONAI/docs/Makefile

    Lines 22 to 23 in 2d0e021

    %: Makefile
    PIP_ROOT_USER_ACTION=ignore pip install -r requirements.txt

the docs/requirements.txt is only for building the docs, and should work with a tiny workstation instance

Types of changes

  • Non-breaking change (fix or new feature that would not break existing functionality).
  • Breaking change (fix or new feature that would cause existing functionality to change).
  • New tests added to cover the changes.
  • Integration tests passed locally by running ./runtests.sh -f -u --net --coverage.
  • Quick tests passed locally by running ./runtests.sh --quick --unittests --disttests.
  • In-line docstrings updated.
  • Documentation updated, tested make html command in the docs/ folder.

@wyli wyli requested review from ericspod and rijobro January 23, 2023 09:10
@wyli
Copy link
Copy Markdown
Contributor Author

wyli commented Jan 23, 2023

/build

@wyli wyli merged commit cce2063 into Project-MONAI:dev Jan 23, 2023
@wyli wyli deleted the fixes-5883 branch January 23, 2023 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

separate docs and dev requirements

3 participants