Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ideas for documentation about just+pyproject.toml+mkdocs #347

Open
3 tasks
epogrebnyak opened this issue Feb 16, 2024 · 0 comments
Open
3 tasks

ideas for documentation about just+pyproject.toml+mkdocs #347

epogrebnyak opened this issue Feb 16, 2024 · 0 comments

Comments

@epogrebnyak
Copy link

cookiecutter-data-science has been foundational for me to learn data piplines, many thanks for creratign and maintaining it.

I have not visited for a while but recently recommended cookiecutter-data-science to someone, and came back, here are few ideas - maybe for documentation at least:

  • make scares people, especailly of Windows, and I find https://github.com/casey/just command runner super helpful. it enables learning and you can try simple commands and extend them, extremely well-thought tool.
  • what is someone wants pyproject.toml instead of setup.py and requirements.txt - it is probably awkwark to move entire project to pyproject.toml, but maybe say somehting about it in docs
  • https://www.mkdocs.org/ and mkdocs-material theme for the documentation? Sphinx is powerful tool, but so easy to get upset with it.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant