Skip to content

Commit 1c172dd

Browse files
authored
Removed requirements file, added documentation & fixed docs not starting (#4672)
Removes project root `requirements.txt` that was previously used for heroku deploys and fixes doc_macro not recognizing python versions without a patch number
1 parent a782e8b commit 1c172dd

3 files changed

Lines changed: 7 additions & 4 deletions

File tree

docs/scripts/doc_macros.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
# RegEx string recommended for semver:
1010
# https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
11-
SEMVER_REGEX = r"^(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)\.(?P<patch>0|[1-9]\d*)(?:-(?P<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+(?P<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"
11+
SEMVER_REGEX = r"^(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)(?:\.(?P<patch>0|[1-9]\d*)(?:-(?P<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+(?P<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?)?$"
1212

1313

1414
# Exception classes
@@ -56,7 +56,9 @@ def get_python_version() -> str:
5656
version = py_ver.read()
5757

5858
if not valid_semver(version):
59-
raise InvalidVersionException(f'Unrecognized Python version: "{version}"!')
59+
raise InvalidVersionException(
60+
f'Unrecognized Python version: "{version.strip()}"!'
61+
)
6062

6163
return version
6264
except FileNotFoundError as err:

docs/setup/deployment/development/stand-alone.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,9 @@ If you want other commands to use it you need to run this command to activate it
100100
source .venv/bin/activate
101101
```
102102

103+
!!! info
104+
While not recommended, pip can still be used to setup your Hypha environment. Just run ```python3 -m pip install -r requirements/<environment>.txt```
105+
103106
### Installing Node Version Manager
104107

105108
NodeJS versions have potential to change. To allow for ease of upgrading, it is recommended to use [Node Version Manager (nvm)](https://github.com/nvm-sh/nvm).

requirements.txt

Lines changed: 0 additions & 2 deletions
This file was deleted.

0 commit comments

Comments
 (0)