mirror of
https://github.com/zama-ai/concrete.git
synced 2026-02-08 19:44:57 -05:00
tools: make sphinx-build warnings errors
- add -W and --keep-going for SPHINXOPTS - use $(MAKE) for make invocations - build the docs in the conformance phase as the sphinx build has checks
This commit is contained in:
26
.github/workflows/continuous-integration.yaml
vendored
26
.github/workflows/continuous-integration.yaml
vendored
@@ -49,12 +49,23 @@ jobs:
|
||||
python -m pip install --upgrade pip
|
||||
python -m pip install poetry
|
||||
make setup_env
|
||||
- name: Conformance
|
||||
- name: Conformance and Docs build
|
||||
id: conformance
|
||||
if: ${{ success() && !cancelled() }}
|
||||
env:
|
||||
# TODO: remove this when JIT doesn't need this
|
||||
# Required to be sure that docs reads all files with MLIR imports properly
|
||||
LD_PRELOAD: /compiler/build/lib/Runtime/libZamalangRuntime.so
|
||||
# pcc launches an internal target with proper flags
|
||||
# docs is run here too as it can fail and we catch errors during the build
|
||||
run: |
|
||||
make pcc
|
||||
./script/make_utils/serialize_targets.sh make pcc docs
|
||||
- name: Archive docs artifacts
|
||||
if: ${{ steps.conformance.outcome == 'success' && !cancelled() }}
|
||||
uses: actions/upload-artifact@v2
|
||||
with:
|
||||
name: html-docs
|
||||
path: docs/_build/html
|
||||
- name: PyTest
|
||||
id: pytest
|
||||
if: ${{ steps.conformance.outcome == 'success' && !cancelled() }}
|
||||
@@ -89,17 +100,6 @@ jobs:
|
||||
with:
|
||||
path: diff-coverage.txt
|
||||
recreate: true
|
||||
- name: Build docs
|
||||
id: docs
|
||||
if: ${{ steps.conformance.outcome == 'success' && !cancelled() }}
|
||||
run: |
|
||||
make docs
|
||||
- name: Archive docs artifacts
|
||||
if: ${{ steps.docs.outcome == 'success' && !cancelled() }}
|
||||
uses: actions/upload-artifact@v2
|
||||
with:
|
||||
name: html-docs
|
||||
path: docs/_build/html
|
||||
- name: Slack Notification
|
||||
if: ${{ always() }}
|
||||
uses: rtCamp/action-slack-notify@v2
|
||||
|
||||
4
Makefile
4
Makefile
@@ -12,7 +12,7 @@ setup_env:
|
||||
|
||||
sync_env:
|
||||
poetry install --remove-untracked
|
||||
make setup_env
|
||||
$(MAKE) setup_env
|
||||
.PHONY: sync_env
|
||||
|
||||
python_format:
|
||||
@@ -135,7 +135,7 @@ docs: clean_docs
|
||||
poetry run sphinx-apidoc -o docs/_apidoc hdk
|
||||
|
||||
@# Docs
|
||||
cd docs && poetry run make html
|
||||
cd docs && poetry run $(MAKE) html SPHINXOPTS='-W --keep-going'
|
||||
.PHONY: docs
|
||||
|
||||
clean_docs:
|
||||
|
||||
Reference in New Issue
Block a user