Skip to content

Commit 16c41ea

Browse files
Store documentation requirements in requirements-docs.txt
1 parent ff9ffc4 commit 16c41ea

3 files changed

Lines changed: 15 additions & 10 deletions

File tree

.github/workflows/cd-docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ jobs:
3939
mkdocs-material-
4040
4141
- name: Install Dependencies
42-
run: pip install mkdocs mkdocs-material mkdocstrings[python] griffe-inherited-docstrings mkdocs-autorefs black mkdocs-jupyter mkdocs-caption
42+
run: pip install -r requirements-docs.txt
4343

4444
- name: Deploy to GitHub Pages
4545
run: mkdocs gh-deploy --force

requirements-docs.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
mkdocs
2+
mkdocs-material
3+
mkdocstrings[python]
4+
griffe-inherited-docstrings
5+
mkdocs-autorefs
6+
black
7+
mkdocs-jupyter
8+
mkdocs-caption

setup.py

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,11 @@ def run(self):
129129
with open('README.md') as fp:
130130
_LONG_DESCRIPTION = fp.read()
131131

132+
# Get documentation build requirements
133+
with open("requirements-docs.txt", "r") as fp:
134+
docs_reqs = fp.readlines()
135+
docs_reqs = [req.replace("\n", "") for req in docs_reqs]
136+
132137
setup(
133138
name='ml-metadata',
134139
version=__version__,
@@ -167,15 +172,7 @@ def run(self):
167172
'six>=1.10,<2',
168173
],
169174
# TODO: Pin versions for docs
170-
extras_require={"docs": ["mkdocs",
171-
"mkdocs-material",
172-
"mkdocstrings[python]",
173-
"griffe-inherited-docstrings",
174-
"mkdocs-autorefs",
175-
"black",
176-
"mkdocs-caption"
177-
]
178-
}
175+
extras_require={"docs": docs_reqs}
179176
python_requires='>=3.9,<4',
180177
packages=find_packages(),
181178
include_package_data=True,

0 commit comments

Comments
 (0)