Repository navigation
Setup documentation #13
Description
In order to boost the adoption of this package, I suggest adding documentation.
In the past, I worked on the setup of a SPHINX documentation in TOX:
https://github.com/victorgarcia98/s2-ws-json-python/tree/main
And got it published in ReadTheDocs:
Activity
sebastiaan-la-fleur commentedon Aug 9, 2023
We should definitely generate some type of documentation. An idea I have is to reuse the documentation provided to pydantic. For example: f255934#diff-1402cdc5485e1b35c6fc47f25e172db57b4cfc4fab64fb6a2668ccdd1171f0f3R67
Every field currently already has a bunch of docs and it would be great if we could utilize them. How that exactly could work, I am unsure. I already checked pydantic and it does not seem to have a docs generator or something similar. Perhaps it does have it but I overlooked it.
Btw, what did you write the RST in your example? I saw docs for the
json()anddict()functions but I cannot find the definitions.victorgarcia98 commentedon Aug 10, 2023
Good point!
After a quick search, I found this sphinx package that could be useful, I'll try to test it 😄
I think it's also showing the docs of the inherited methods, in this case, from the ValidateValusMixin.