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

Add breadcrumb README files in various directories #416

Closed
drewoldag opened this issue Feb 10, 2024 · 0 comments · Fixed by #483
Closed

Add breadcrumb README files in various directories #416

drewoldag opened this issue Feb 10, 2024 · 0 comments · Fixed by #483
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@drewoldag
Copy link
Collaborator

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
@delucchi-cmu delucchi-cmu added the documentation Improvements or additions to documentation label Feb 26, 2024
@drewoldag drewoldag self-assigned this Sep 30, 2024
@drewoldag drewoldag linked a pull request Sep 30, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants