Skip to content

Commit 78587f7

Browse files
authored
Update documentation for v3.0 release (#284)
Update the docs and bring back the docs publishing workflow step.
1 parent 14b81e8 commit 78587f7

File tree

12 files changed

+814
-103
lines changed

12 files changed

+814
-103
lines changed

.github/actions/build-docs/action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ runs:
2121
- name: Build html documentation
2222
shell: bash
2323
run: |
24-
poetry run pdoc pinecone/ --favicon ./favicon-32x32.png --docformat google -o ./docs
24+
poetry run pdoc pinecone '!pinecone.core' '!pinecone.utils' --favicon ./favicon-32x32.png --docformat google -o ./docs

.github/workflows/merge.yaml

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: 'Merge to main'
1+
name: 'CI (main)'
22

33
on:
44
push:
@@ -18,15 +18,15 @@ jobs:
1818
with:
1919
python-version: 3.11
2020

21-
# - name: Push documentation artifacts to sdk-docs
22-
# uses: cpina/github-action-push-to-another-repository@main
23-
# env:
24-
# SSH_DEPLOY_KEY: ${{ secrets.SSH_DEPLOY_KEY }}
25-
# with:
26-
# source-directory: docs
27-
# destination-github-username: pinecone-io
28-
# destination-repository-name: sdk-docs
29-
# user-email: [email protected]
30-
# target-branch: main
31-
# target-directory: python
32-
# commit-message: 'Python: automated documentation build - pinecone-python-client merge SHA: ${{ github.sha }}'
21+
- name: Push documentation artifacts to sdk-docs
22+
uses: cpina/github-action-push-to-another-repository@main
23+
env:
24+
SSH_DEPLOY_KEY: ${{ secrets.SSH_DEPLOY_KEY }}
25+
with:
26+
source-directory: docs
27+
destination-github-username: pinecone-io
28+
destination-repository-name: sdk-docs
29+
user-email: [email protected]
30+
target-branch: main
31+
target-directory: python
32+
commit-message: 'Python: automated documentation build - pinecone-python-client merge SHA: ${{ github.sha }}'

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,22 @@
11
# Contributing
22

3+
## Installing development versions
4+
5+
If you want to explore a potential code change, investigate
6+
a bug, or just want to try unreleased features, you can also install
7+
specific git shas.
8+
9+
Some example commands:
10+
11+
```shell
12+
pip3 install git+https://[email protected]/pinecone-io/pinecone-python-client.git
13+
pip3 install git+https://[email protected]/pinecone-io/pinecone-python-client.git@example-branch-name
14+
pip3 install git+https://[email protected]/pinecone-io/pinecone-python-client.git@44fc7ed
15+
16+
poetry add git+https://github.com/pinecone-io/pinecone-python-client.git@44fc7ed
17+
```
18+
19+
320
## Developing locally with Poetry
421

522
[Poetry](https://python-poetry.org/) is a tool that combines [virtualenv](https://virtualenv.pypa.io/en/latest/) usage with dependency management, to provide a consistent experience for project maintainers and contributors who need to develop the pinecone-python-client

0 commit comments

Comments
 (0)