Skip to content

Improve py docs#1942

Merged
abhizer merged 3 commits intomainfrom
improve_py_docs
Jun 25, 2024
Merged

Improve py docs#1942
abhizer merged 3 commits intomainfrom
improve_py_docs

Conversation

@abhizer
Copy link
Copy Markdown
Contributor

@abhizer abhizer commented Jun 25, 2024

Is this a user-visible change (yes/no): yes

This PR changes the structure of the python docs.
We change the structure of feldera.rst file and include it in version control so that the important parts show up first.
Note that this means, if a new module / file is added, it must be manually inserted in feldera.rst.

Unsure if this requires a changelog entry.

abhizer added 2 commits June 25, 2024 18:08
Signed-off-by: Abhinav Gyawali <22275402+abhizer@users.noreply.github.com>
Signed-off-by: Abhinav Gyawali <22275402+abhizer@users.noreply.github.com>
@abhizer abhizer added documentation Improvements or additions to documentation python-sdk Issues related to the feldera python sdk labels Jun 25, 2024
@abhizer abhizer requested review from ryzhyk and snkas June 25, 2024 13:19
@abhizer
Copy link
Copy Markdown
Contributor Author

abhizer commented Jun 25, 2024

Main page:
image
Modules:
image

Signed-off-by: Abhinav Gyawali <22275402+abhizer@users.noreply.github.com>
@abhizer abhizer mentioned this pull request Jun 25, 2024
16 tasks
@abhizer abhizer merged commit fca2d1b into main Jun 25, 2024
@abhizer abhizer deleted the improve_py_docs branch June 25, 2024 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation python-sdk Issues related to the feldera python sdk

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants