search

skshetry / webdav4

WebDAV client library with a fsspec based filesystem and a CLI.
https://skshetry.github.io/webdav4
MIT License
66 stars 16 forks source link

No documentation on GitHub #120

Closed daramarak closed 2 years ago

daramarak commented 2 years ago

I think there should be documentation, but when clicking on ClientAPI in the readme of GitHub there is no documentation.

All that show is:

Client

.. automodule:: webdav4.client :show-inheritance: :members:

I guess this is not how it should be.

skshetry commented 2 years ago

Hi, @daramarak. It’s generated using sphinx from docstrings in the code: https://skshetry.github.io/webdav4/.

daramarak commented 2 years ago

Thank you, that link works perfect. But confusing that the link in github didnt. This is a great webdav library, i have tried 3 now, and your is definitely the best. Would be sad if people didn't use it because they couldn't find the documentation.

skshetry commented 2 years ago

Thank you for nice words. The docs link is at the sidebar. Also, if you are not aware, this also has an fsspec-compatible filesystem, so the APIs work the same way in all the filesystems, s3, azure, google drive, google cloud storage, ssh and of course, webdav. 🙂

skshetry commented 2 years ago

Closing for now. Feel free to open new issue for bugs/feature requests. 🙂