-
Notifications
You must be signed in to change notification settings - Fork 148
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9dcf1c4
commit 8fef8d1
Showing
333 changed files
with
17,055 additions
and
244 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Check that the documentation is up to date | ||
name: Check that the documentation is up to date | ||
|
||
on: | ||
# Nightly Release @ 3AM after each work day | ||
- cron: "0 3 * * 2-6" | ||
|
||
jobs: | ||
check-doc: | ||
name: Check that the documentation is up to date | ||
runs-on: ubuntu-20.04 | ||
steps: | ||
- name: Check that the documentation is up to date | ||
shell: bash | ||
run: | | ||
set +e | ||
./ci/scripts/make_apidocs.sh |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
#!/usr/bin/env bash | ||
|
||
# In this script, we: | ||
# create a fresh directory | ||
# create a fresh venv | ||
# download the last CP | ||
# make API docs for it | ||
|
||
FRESH_DIRECTORY="tempdirectoryforapidocs" | ||
|
||
# Keep a copy of the doc, to check changes | ||
rm -rf docs-copy | ||
cp -r docs docs-copy | ||
|
||
# Remote old files | ||
rm docs/dev/api/*.md | ||
|
||
set -e | ||
|
||
# Make a new fresh venv, and install the last public CP there (hence, the --isolated to not take | ||
# nightlies) | ||
rm -rf "$FRESH_DIRECTORY" | ||
mkdir "$FRESH_DIRECTORY" | ||
cd "$FRESH_DIRECTORY" | ||
python3 -m venv .venvtrash | ||
source .venvtrash/bin/activate | ||
pip install concrete-python --index-url https://pypi.org/simple --isolated | ||
pip install lazydocs | ||
|
||
# Make API doc files | ||
.venvtrash/bin/lazydocs --output-path="../docs/dev/api" --overview-file="README.md" --src-base-url="../../" --no-watermark concrete | ||
cd - | ||
|
||
# Add the files in the summary | ||
FILES=$(cd docs && find dev/api -name "*.md") | ||
|
||
TMP_FILE=$(mktemp /tmp/apidocs.XXXXXX) | ||
rm -rf "$TMP_FILE" | ||
touch "$TMP_FILE" | ||
|
||
for f in $FILES | ||
do | ||
filename=$(echo "$f" | rev | cut -d '/' -f 1 | rev) | ||
|
||
echo " - [$filename]($f)" >> "$TMP_FILE" | ||
done | ||
|
||
FINAL_FILE="docs/SUMMARY.md" | ||
NEW_FINAL_FILE="docs/SUMMARY.md.tmp" | ||
|
||
grep "<!-- auto-created, do not edit, begin -->" $FINAL_FILE -B 100000 > $NEW_FINAL_FILE | ||
sort "$TMP_FILE" | grep -v "\[README.md\]" >> $NEW_FINAL_FILE | ||
grep "<!-- auto-created, do not edit, end -->" $FINAL_FILE -A 100000 >> $NEW_FINAL_FILE | ||
|
||
mv $NEW_FINAL_FILE $FINAL_FILE | ||
|
||
rm -rf "$FRESH_DIRECTORY" | ||
|
||
# New files? | ||
echo "Warning. You might have new API-doc files to git add & push, don't forget" | ||
|
||
# Fixing the path issues, to point on files in GitHub | ||
WHICH_PYTHON_VERSION=$(python3 --version | cut -f 2 -d " " | cut -f 1-2 -d ".") | ||
sed -i "" -e "s@../../$FRESH_DIRECTORY/.venvtrash/lib/python$WHICH_PYTHON_VERSION/site-packages/@../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/@g" docs/dev/api/*.md | ||
|
||
# Fixing the links in README.md, which fails (missing .'s for some reason): remove the #headers | ||
sed -i "" -e "[email protected]#module-.*)@.md)@g" docs/dev/api/README.md | ||
sed -i "" -e "[email protected]#function-.*)@.md)@g" docs/dev/api/README.md | ||
sed -i "" -e "[email protected]#class-.*)@.md)@g" docs/dev/api/README.md | ||
|
||
# Removed the "object addresses" and "function addresses", since they are not constant | ||
sed -i "" -e "s@object at 0x[a-zA-z0-9]*@object at ADDRESS@g" docs/*.md | ||
sed -i "" -e "s@object at 0x[a-zA-z0-9]*@object at ADDRESS@g" docs/*/*.md | ||
sed -i "" -e "s@object at 0x[a-zA-z0-9]*@object at ADDRESS@g" docs/*/*/*.md | ||
|
||
sed -i "" -e "s@function Int at 0x[a-zA-z0-9]*@function Int at ADDRESS@g" docs/*.md | ||
sed -i "" -e "s@function Int at 0x[a-zA-z0-9]*@function Int at ADDRESS@g" docs/*/*.md | ||
sed -i "" -e "s@function Int at 0x[a-zA-z0-9]*@function Int at ADDRESS@g" docs/*/*/*.md | ||
|
||
# FIXME: remove this once the PR has been merged once | ||
sed -i "" -e "s@https://github.com/zama-ai/concrete-compiler-internal/blob/main/LICENSE.txt@https://github.com/zama-ai/concrete/blob/main/LICENSE.txt@g" ./docs/dev/api/concrete.lang.dialects.md ./docs/dev/api/concrete.compiler.md ./docs/dev/api/concrete.lang.md | ||
|
||
# Was there changes? | ||
if diff -r docs docs-copy; then | ||
echo "" | ||
else | ||
echo "There is a difference in the docs, please commit the changes" | ||
exit -1 | ||
fi | ||
|
||
# If there were changes, the previous command will stop, thanks to set -e | ||
rm -rf docs-copy | ||
|
||
echo "Successful end" | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Analysis/TypeInferenceAnalysis.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Analysis/Utils.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...ilers/concrete-compiler/compiler/include/concretelang/Bindings/Python/CompilerAPIModule.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Bindings/Python/DialectModules.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/CAPI/Wrappers.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/ClientLib/ClientLib.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Common/CRT.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Common/Compat.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Common/Csprng.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Common/Error.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Common/Keys.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Common/Keysets.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Common/Protocol.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Common/Transformers.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Common/Values.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Conversion/ConcreteToCAPI/Pass.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Conversion/ExtractSDFGOps/Pass.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...rs/concrete-compiler/compiler/include/concretelang/Conversion/FHETensorOpsToLinalg/Pass.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Conversion/FHEToTFHECrt/Pass.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Conversion/FHEToTFHEScalar/Pass.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Conversion/LinalgExtras/Passes.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...rete-compiler/compiler/include/concretelang/Conversion/MLIRLowerableDialectsToLLVM/Pass.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Conversion/Passes.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...rs/concrete-compiler/compiler/include/concretelang/Conversion/SDFGToStreamEmulator/Pass.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Conversion/SimulateTFHE/Pass.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...ncrete-compiler/compiler/include/concretelang/Conversion/TFHEGlobalParametrization/Pass.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...rs/concrete-compiler/compiler/include/concretelang/Conversion/TFHEKeyNormalization/Pass.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Conversion/TFHEToConcrete/Pass.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Conversion/Tools.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Conversion/TracingToCAPI/Pass.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Conversion/Utils/Dialects/SCF.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
compilers/concrete-compiler/compiler/include/concretelang/Conversion/Utils/Dialects/Tensor.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.