drivendataorg / cookiecutter-data-science

A logical, reasonably standardized, but flexible project structure for doing and sharing data science work.
https://cookiecutter-data-science.drivendata.org/
MIT License
7.99k stars 2.41k forks source link

Add commandline options table #350

Closed pjbull closed 3 months ago

pjbull commented 4 months ago

Adds page with all commandline options and documentation for them to the docs.

Generated from JSON so in the future we can use it for CLI man pages, etc.

render[bot] commented 4 months ago

Your Render PR Server URL is https://cookiecutter-data-science-pr-350.onrender.com.

Follow its progress at https://dashboard.render.com/static/srv-cnsguptjm4es738k56s0.

pjbull commented 4 months ago

C'mon render. SMDH.

  File "/opt/render/project/src/docs/scripts/configuration-table.py", line 22
    if choices := item.get("choices", None):
                ^
SyntaxError: invalid syntax
==> Build failed 😞
pjbull commented 4 months ago

new page here: https://cookiecutter-data-science-pr-350.onrender.com/all-options/

chrisjkuch commented 4 months ago

C'mon render.

I'm still totally flummoxed as to why my render deploys look different from my local.

jayqi commented 4 months ago

I agree that this table feels hard to read. Might consider a list, or sublists within table cells by combining columns (I think this may be along the lines of @chrisjkuch's suggestion).

pjbull commented 4 months ago

Yeah, I'm definitely open to other formats. I like the density of a table, but because of the levels in the tree we end up with too much whitespace and columns that are super narrow.

Maybe we just remove the top level into page sections? That way they show up in the nav, and we can lop off 2 columns.

pjbull commented 4 months ago

I'm still totally flummoxed as to why my render deploys look different from my local.

Is this preview better? I think I moved us from 3.7 -> 3.11 on the builds, which definitely could have been part of it.

chrisjkuch commented 4 months ago
image

I think it's better! (gotta go fast)

pjbull commented 3 months ago

Updated to use sections for the top-level instead: https://cookiecutter-data-science-pr-350.onrender.com/all-options/