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

Adds Sphinx config to generate Python SDK docs. #3301

Merged
merged 1 commit into from
Jan 9, 2025
Merged

Conversation

dom96
Copy link
Collaborator

@dom96 dom96 commented Jan 7, 2025

Usage:

# set up venv with sphinx and sphinx-markdown-builder installed
make markdown

This will generate something like https://gist.github.com/dom96/4ce2594239d4672262eefed992402563.

@dom96 dom96 requested a review from hoodmane January 7, 2025 18:15
@dom96 dom96 requested review from a team as code owners January 7, 2025 18:15
@dom96 dom96 requested a review from danlapid January 7, 2025 18:15
@dom96 dom96 force-pushed the dominik/sphinx-docs branch 2 times, most recently from 8389436 to 2c23ffe Compare January 7, 2025 18:16
Copy link
Collaborator

@danlapid danlapid left a comment

Choose a reason for hiding this comment

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

I don’t have any strong or smart opinions on how to generate docs for this.
I’ll delegate to @hoodmane to review this 🙏

@hoodmane
Copy link
Contributor

hoodmane commented Jan 8, 2025

sphinx-markdown-builder doesn't look super well maintained but it gets some commits. It would be nice if we could generate html directly and use that, but it wouldn't look like the rest of the cloudflare docs. I'm interested to see if this looks okay when rendered. Anyways, if we start out with this approach and find something else we like better later then we can just change it.

@dom96 dom96 force-pushed the dominik/sphinx-docs branch 2 times, most recently from 65bec9d to 0c48c4c Compare January 9, 2025 17:31
@dom96 dom96 force-pushed the dominik/sphinx-docs branch from 0c48c4c to 4dbaa80 Compare January 9, 2025 17:32
@dom96 dom96 merged commit 4b0098e into main Jan 9, 2025
15 checks passed
@dom96 dom96 deleted the dominik/sphinx-docs branch January 9, 2025 18: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.

3 participants