python-project-template icon indicating copy to clipboard operation
python-project-template copied to clipboard

Add breadcrumb README files in various directories

Open drewoldag opened this issue 1 year ago • 0 comments

We currently have a breadcrumb README in the .../docs/notebooks directory when a new project is hydrated. I'm suggesting that we add more and perhaps use those READMEs as a place to add a little more documentation.

i.e. for the one in the .../docs/notebooks directory, something like:

This directory contains all the notebooks that will be rendered in ReadTheDocs. 
You'll have to be sure to add the file name to the ../notebooks.rst file.
You may also need to update the requirements.txt file if your notebooks have requirements not specified in pyproject.toml.

For more information look here: https://lincc-ppt.readthedocs.io/en/latest/practices/sphinx.html#python-notebooks
Or if you still have questions contact us: https://lincc-ppt.readthedocs.io/en/latest/source/contact.html

We could do something like this for:

  • .github
  • benchmarks
  • src
  • tests

drewoldag avatar Feb 10 '24 00:02 drewoldag