Merge branch 'dev/docs' of https://github.com/OpenProteinAI/openprotein-python into release

Author: mbarber

.github/workflows/s3.yaml

@@ -0,0 +1,74 @@
+name: Sphinx Build and Sync to S3
+
+on:
+  push:
+    branches:
+    - develop
+    - prod
+
+jobs:
+  build_and_sync:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+
+    - name: Install Sphinx
+      run: |
+        python -m pip install --upgrade pip
+        pip install sphinx
+
+    - name: Build HTML with Sphinx
+      run: |
+        cd apidocs
+        make html
+
+    - name: Get bucket name
+      shell: bash
+      run: |
+        branch=$(echo ${GITHUB_REF#refs/heads/}); \
+        if [ $branch == 'develop' ]; \
+        then bucket=openprotein-docs-dev; \
+        elif [ $branch == 'prod' ]; \
+        then bucket=openprotein-docs-prod; \
+        else exit 1; fi; \
+        echo $bucket; \
+        echo "bucket=$bucket" >> $GITHUB_OUTPUT
+      id: bucket_name
+
+    - name: Get distribution ID
+      shell: bash
+      run: |
+        branch=$(echo ${GITHUB_REF#refs/heads/}); \
+        if [ $branch == 'develop' ]; \
+        then dist=E3SMW2DYY71HHW; \
+        elif [ $branch == 'prod' ]; \
+        then dist=E1CUT1CP31D5NK; \
+        else exit 1; fi; \
+        echo $dist; \
+        echo "dist=$dist" >> $GITHUB_OUTPUT
+      id: dist_id
+      
+    - name: Configure AWS credentials
+      uses: aws-actions/configure-aws-credentials@v1
+      with:
+        aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+        aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+        aws-region: us-east-1
+
+    - name: Sync apidocs to S3
+      env:
+        AWS_S3_BUCKET: ${{ steps.bucket_name.outputs.bucket }}
+      shell: bash
+      run: |
+        aws s3 sync apidocs/_build/html s3://${AWS_S3_BUCKET}/apidocs/
+
+    - name: Invalidate CloudFront cache
+      env:
+        DISTRIBUTION_ID: ${{ steps.dist_id.outputs.dist }}
+      run: |
+        aws cloudfront create-invalidation --distribution-id ${DISTRIBUTION_ID} --paths "/apidocs/*"

.gitignore

@@ -17,7 +17,7 @@ __pycache__/
 
 # Distribution / packaging
 .Python
-build/
+#build/
 develop-eggs/
 dist/
 downloads/
@@ -136,3 +136,5 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+/.quarto/

apidocs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)