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

[SDK] [Python] feat: add markdown doc generation using sphinx #1212

Merged
merged 2 commits into from
Nov 17, 2023

Conversation

leric7
Copy link
Collaborator

@leric7 leric7 commented Nov 6, 2023

Description

We need to generate Markdown docs for Python SDK using sphinx.

Summary of changes

  • Added sphinx and relevant plugins as dev dependency.
  • Defined new make commands to generate doc.
  • Updated SUMMARY.MD for Python SDK doc.
  • Updated docstring for all of the Python SDK modules.

How test the changes

Related issues

Keywords for linking issues

Closes #1084

Operational checklist

  • All new functionality is covered by tests
  • Any related documentation has been changed or added

Copy link

vercel bot commented Nov 6, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
fortune-exchange-oracle-server 🔄 Building (Inspect) Visit Preview 💬 Add feedback Nov 6, 2023 4:25pm
fortune-job-launcher-server 🔄 Building (Inspect) Visit Preview 💬 Add feedback Nov 6, 2023 4:25pm
job-launcher-server 🔄 Building (Inspect) Visit Preview 💬 Add feedback Nov 6, 2023 4:25pm
12 Ignored Deployments
Name Status Preview Comments Updated (UTC)
escrow-dashboard ⬜️ Ignored (Inspect) Nov 6, 2023 4:25pm
faucet-server ⬜️ Ignored (Inspect) Visit Preview Nov 6, 2023 4:25pm
fortune-exchange-oracle ⬜️ Ignored (Inspect) Nov 6, 2023 4:25pm
fortune-job-launcher-client ⬜️ Ignored (Inspect) Nov 6, 2023 4:25pm
fortune-recording-oracle ⬜️ Ignored (Inspect) Nov 6, 2023 4:25pm
fortune-reputation-oracle ⬜️ Ignored (Inspect) Nov 6, 2023 4:25pm
hufi-exchange-oracle-server ⬜️ Ignored (Inspect) Visit Preview Nov 6, 2023 4:25pm
hufi-job-launcher-server ⬜️ Ignored (Inspect) Visit Preview Nov 6, 2023 4:25pm
hufi-recording-oracle-server ⬜️ Ignored (Inspect) Visit Preview Nov 6, 2023 4:25pm
hufi-reputation-oracle ⬜️ Ignored (Inspect) Visit Preview Nov 6, 2023 4:25pm
job-launcher-client ⬜️ Ignored (Inspect) Visit Preview Nov 6, 2023 4:25pm
reputation-oracle-server ⬜️ Ignored (Inspect) Visit Preview Nov 6, 2023 4:25pm

@leric7 leric7 linked an issue Nov 6, 2023 that may be closed by this pull request
@leric7 leric7 self-assigned this Nov 7, 2023
@leric7 leric7 merged commit e3adbf3 into develop Nov 17, 2023
23 checks passed
@leric7 leric7 deleted the eric/python-autodoc branch November 17, 2023 12:09
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.

SDK - Python autodocs
2 participants