Skip to content

Conversation

mstoelzle
Copy link
Contributor

@solangegbv I started adding some Docs for the package. The instructions for building and serving the docs on the localhost were added to the README.

For now, let's put the emphasis on the API documentation. We can polish the Examples and the Quick Start guide later...
Screenshot 2025-07-31 at 21 13 36

@mstoelzle mstoelzle requested a review from solangegbv July 31, 2025 19:15
@solangegbv
Copy link
Collaborator

@mstoelzle
Is there a more suitable way of documenting my class to obtain something readable?
image

@mstoelzle
Copy link
Contributor Author

Screenshot 2025-08-01 at 11 30 10

@solangegbv I guess this part is not necessary, as at least the methods are documented separately below in the docstring of each method. I am using MKDocs. You could have a look at other examples of APIs that use MKDocs, for example, FastAPI.

Here, you can see the structure used to document the APIRouter class: https://github.com/fastapi/fastapi/blob/master/fastapi/routing.py#L596 with the resulting Doc. page: https://fastapi.tiangolo.com/reference/apirouter/

@mstoelzle mstoelzle merged commit 06082e6 into main Aug 2, 2025
26 checks passed
@mstoelzle mstoelzle deleted the feature/docs branch August 2, 2025 20:46
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