Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add python client #460

Merged
merged 1 commit into from
Jan 13, 2025
Merged

Docs: Add python client #460

merged 1 commit into from
Jan 13, 2025

Conversation

ZigaMr
Copy link
Contributor

@ZigaMr ZigaMr commented Dec 2, 2024

This PR adds python client documentation to https://api.docs.oasis.io/

Copy link

netlify bot commented Dec 2, 2024

Deploy Preview for oasisprotocol-sapphire-paratime canceled.

Name Link
🔨 Latest commit ced1878
🔍 Latest deploy log https://app.netlify.com/sites/oasisprotocol-sapphire-paratime/deploys/678533829edccb00081bcb97

@ZigaMr ZigaMr changed the title Add python docs Docs: Add python client Dec 2, 2024
clients/py/docs/source/index.rst Outdated Show resolved Hide resolved
clients/py/docs/source/conf.py Outdated Show resolved Hide resolved
clients/py/docs/source/conf.py Outdated Show resolved Hide resolved
.github/workflows/ci-docs.yaml Outdated Show resolved Hide resolved
.github/workflows/ci-docs.yaml Outdated Show resolved Hide resolved
Copy link
Member

@matevz matevz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm getting

../README.md:34: ERROR: Unknown target name: "sapphirepy/deoxysii.py". [docutils]
../README.md:34: ERROR: Unknown target name: "tests/testdata/Deoxys-II-256-128.json". [docutils]
/home/oa/sapphire-paratime/clients/py/venv/lib/python3.12/site-packages/sapphirepy/__init__.py:docstring of sapphirepy:1: WARNING: duplicate object description of sapphirepy, other instance in index, use :no-index: for one of them

when building the docs. Any ideas?

.github/workflows/ci-docs.yaml Outdated Show resolved Hide resolved
clients/py/Makefile Show resolved Hide resolved
@matevz matevz force-pushed the ZigaMr/python-api-docs branch 7 times, most recently from 3564cbe to 220933e Compare January 13, 2025 15:33
@matevz matevz force-pushed the ZigaMr/python-api-docs branch from 220933e to ced1878 Compare January 13, 2025 15:38
@matevz matevz self-assigned this Jan 13, 2025
@matevz matevz merged commit ed1e9fc into main Jan 13, 2025
12 checks passed
@matevz matevz deleted the ZigaMr/python-api-docs branch January 13, 2025 17:04
github-actions bot added a commit that referenced this pull request Jan 13, 2025
…l/ZigaMr/python-api-docs

docs: Add python client ed1e9fc
github-actions bot added a commit that referenced this pull request Jan 13, 2025
…gaMr/python-api-docs

docs: Add python client ed1e9fc
github-actions bot added a commit that referenced this pull request Jan 13, 2025
…igaMr/python-api-docs

docs: Add python client ed1e9fc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants