Skip to content

Commit 5606f84

Browse files
docs: convert auto-generated documentation to from pydoc to sphinx
1 parent b7c37af commit 5606f84

34 files changed

+896
-8821
lines changed

.github/workflows/release.yaml

+4-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,10 @@ jobs:
5151
- name: Run poetry install
5252
run: poetry install --with docs
5353
- name: Create new documentation
54-
run: poetry run pdoc --html -o docs/detailed-documentation src/codeflare_sdk && pushd docs/detailed-documentation && rm -rf cluster job utils && mv codeflare_sdk/* . && rm -rf codeflare_sdk && popd && find docs/detailed-documentation -type f -name "*.html" -exec bash -c "echo '' >> {}" \;
54+
run: |
55+
sphinx-apidoc -o docs/sphinx src/codeflare_sdk "**/*test_*" --force
56+
make clean -C docs/sphinx
57+
make html -C docs/sphinx
5558
- name: Copy demo notebooks into SDK package
5659
run: cp -r demo-notebooks src/codeflare_sdk/demo-notebooks
5760
- name: Run poetry build

docs/authentication.md

-40
This file was deleted.

docs/cluster-configuration.md

-46
This file was deleted.

0 commit comments

Comments
 (0)