Skip to content

Commit

Permalink
Try new strategy for better rendering with gopages
Browse files Browse the repository at this point in the history
  • Loading branch information
aulorbe committed Jul 17, 2024
1 parent 646fc54 commit 8246c74
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 13 deletions.
12 changes: 2 additions & 10 deletions .github/actions/build-docs/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,7 @@ runs:
- name: Check out the repository
uses: actions/checkout@v4

- name: Write html file to docs directory
- name: Run gopages to generate documentation
shell: bash
run: |
# Check if the ./docs directory exists
if [ -d "./docs" ]; then
echo "Directory ./docs exists."
else
echo "Directory ./docs does not exist. Creating it now..."
mkdir ./docs
fi
godoc -url pkg/github.com/pinecone-io/go-pinecone/pinecone/ > ./docs/index.html
echo "godoc command has been executed and the output has been saved to ./docs/index.html"
gopages
4 changes: 2 additions & 2 deletions .github/actions/setup/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ runs:
shell: bash
run: go mod download

- name: Install godoc
- name: Install gopages
shell: bash
run: go install golang.org/x/tools/cmd/godoc@latest
run: go install github.com/johnstarich/go/gopages@latest
2 changes: 1 addition & 1 deletion .github/workflows/build-and-publish-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
env:
SSH_DEPLOY_KEY: ${{ secrets.SSH_DEPLOY_KEY }}
with:
source-directory: docs
source-directory: dist/pkg/github.com/pinecone-io/go-pinecone/pinecone
destination-github-username: pinecone-io
destination-repository-name: sdk-docs
user-email: [email protected]
Expand Down

0 comments on commit 8246c74

Please sign in to comment.