22 ms·

I hadn't heard of this and it looks great. But then I also came across pdocs[0]. Other than the 3rd bullet which looks outdated, how does the rest of the compar

I hadn't heard of this and it looks great. But then I also came across pdocs[0]. Other than the 3rd bullet which looks outdated, how does the rest of the comparison[1] hold up? And do you really not support Python3.7? Isn't Debian Stable using Python3.7? [0] https://github.com/timothycrosley/pdocs https://github.com/timothycrosley/pdocs [1] https://github.com/timothycrosley/pdocs/#differences-between-pdocs-and-pdoc https://github.com/timothycrosley/pdocs/#differences-between...

mhils 6y ago
pdocs is what a friendly fork looks like, happy to see it. :) I've sent an email to Timothy a few days ago, I'd be more than happy to eventually join forces. We also invited the pdoc3 author early on to collaborate under the only condition that he'd need to change his swastika avatar to something less offensive, but alas. :/ Regarding the comparion to pdocs: - We only support HTML output at the moment, pdocs does support Markdown. - Type annotations are now a first class citizen in pdoc, including string forward references. - 3.8 is a requirement for pdoc, but you can use it to document 3.5 code. - pdoc now uses tox, mypy, flake8, GitHub Actions... and has 100% test coverage :) - and we also have a Python API: https://pdoc.dev/docs/pdoc.html#pdoc Overall, I think we try to be a bit simpler compared to pdocs. For example, we use argparse instead of hug to not introduce additional dependencies, and we really focus on the "generate standalone documentation" use case. That being said, I can recommend pdocs just as well. :)
- kylebarron 6y ago
  Are you interested in adding support for Markdown output? We're using pdocs specifically so that we can integrate it inside mkdocs output. Example API docs from pdocs, rendered in mkdocs: https://cogeotiff.github.io/rio-tiler/api/rio_tiler/io/cogeo/ https://cogeotiff.github.io/rio-tiler/api/rio_tiler/io/cogeo... Though I have to say your HTML output looks quite nice.
  - mhils 6y ago
    Definitely, I'd be happy to merge a PR! But nothing wrong with using pdocs. :)

mhils 6y ago

pdocs is what a friendly fork looks like, happy to see it. :) I've sent an email to Timothy a few days ago, I'd be more than happy to eventually join forces. We also invited the pdoc3 author early on to collaborate under the only condition that he'd need to change his swastika avatar to something less offensive, but alas. :/ Regarding the comparion to pdocs: - We only support HTML output at the moment, pdocs does support Markdown. - Type annotations are now a first class citizen in pdoc, including string forward references. - 3.8 is a requirement for pdoc, but you can use it to document 3.5 code. - pdoc now uses tox, mypy, flake8, GitHub Actions... and has 100% test coverage :) - and we also have a Python API: https://pdoc.dev/docs/pdoc.html#pdoc Overall, I think we try to be a bit simpler compared to pdocs. For example, we use argparse instead of hug to not introduce additional dependencies, and we really focus on the "generate standalone documentation" use case. That being said, I can recommend pdocs just as well. :)

kylebarron 6y ago
Are you interested in adding support for Markdown output? We're using pdocs specifically so that we can integrate it inside mkdocs output. Example API docs from pdocs, rendered in mkdocs: https://cogeotiff.github.io/rio-tiler/api/rio_tiler/io/cogeo/ https://cogeotiff.github.io/rio-tiler/api/rio_tiler/io/cogeo... Though I have to say your HTML output looks quite nice.
- mhils 6y ago
  Definitely, I'd be happy to merge a PR! But nothing wrong with using pdocs. :)