gwlilabmit/rendseq

Add notebooks to readthedocs

Open

#45 opened on Jun 20, 2022

View on GitHubContributor guide
 (2 comments) (1 reaction) (0 assignees)HTML (3 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (0 stars)
PR merge metrics
 (PR metrics pending)

Description

Should be straightforward, instructions here: https://docs.readthedocs.io/en/stable/guides/jupyter.html

Contributor guide

Research direction
Follow the Read the Docs guide for adding Jupyter notebooks (link provided). You will need to create or modify the `.readthedocs.yaml` file to include the `build.jobs` section that renders notebooks, and ensure the notebooks are placed in the correct directory. Then test locally by triggering a build.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80