lincc-frameworks / lincc-frameworks/python-project-template
RTD template: add buttons to download and run notebooks
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Jinja
- Stars
- 85
- Forks
- 16
- Avg merge
- 6h 18m
- Merged PRs (30d)
- 1
Description
It would be great if the Read the Docs HTML documentation included buttons to download notebooks (as implemented in the LSDB RTD) and to run the notebooks on Google Colab.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing how the Read the Docs HTML documentation is produced in this template and compare the LSDB RTD implementation mentioned in the issue. Identify where notebook pages or assets are configured, then verify that generated documentation includes buttons to download notebooks and run them on Google Colab.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100