Deploying datachain-documentation with    Cloudflare Pages

View logs

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.83%. Comparing base (e455180) to head (fb867df).

@@           Coverage Diff           @@
##             main     #577   +/-   ##
=======================================
  Coverage   87.83%   87.83%           
=======================================
  Files         100      100           
  Lines        9993     9993           
  Branches     1356     1356           
=======================================
  Hits         8777     8777           
  Misses        873      873           
  Partials      343      343           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Do we mean sth like this ?

No. It looks like Python API docs to me. It should be more like what we have in dvc.org for CLI. I'm not sure if there are good example for this engine.

I see mkdocs support for cli autodocs with mkdocs-click extension i.e for cli using click. But, for us, I see we use argparse.

@iterative/datachain I see we lack proper restructuring for cli commands. So, could you please check the feasibility of using click for proper structure? Also, we can generate the docs using mkdocs-click.

If we don't want to take that road, we should basically follow the same procedure as we do for dvc.org i.e write them manually for all the commands.

So, could you please check the feasibility of using click for proper structure

tbh, I don't like click. To my mind it doesn't provide enough value for an extra dependency, standard lib gives 95% of what we need. Also, click is breaking some basic (to my mind) things. E.g. there is no way you could append -v at the end of the command to debug it (you have to put in the right position, somewhere in between all args).

If we don't want to take that road, we should basically follow the same procedure as we do for dvc.org i.e write them manually for all the commands.

@skshetry what is your take on this?