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.

Sign up for GitHub

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

Jump to bottom

Refresh LakeFS Python SDK API Reference Using MkDocs #8721

Open
nopcoder opened this issue Feb 26, 2025 · 0 comments
Open

Refresh LakeFS Python SDK API Reference Using MkDocs #8721

nopcoder opened this issue Feb 26, 2025 · 0 comments
Labels
area/sdk/python contributor docs Improvements or additions to documentation

Comments

@nopcoder
Copy link
Contributor

The existing Sphinx-generated documentation for the LakeFS Python package (pydocs-lakefs.lakefs.io) is considered outdated in terms of user experience (UX).
We aim to transition to MkDocs, which offers better UX for developers seeking detailed reference material.

Proposed Solution:

Migration out of current Python API references to use MkDocs.
Reference the generated API reference documentation site from lakeFS Python documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/sdk/python contributor docs Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@nopcoder