cyclus / cyclus/cyclus.github.com

Create a gallery of nice ipython notebook examples

Open
#244 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

0 - Backlog
Dominant language
Python
Stars
8
Forks
33
PR merge metrics
No merged PRs in 30d

Description

We probably want to do this with the sphinx-gallery sphinx plugin.

https://github.com/sphinx-gallery/sphinx-gallery

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the repository's existing documentation structure and the proposed sphinx-gallery plugin at https://github.com/sphinx-gallery/sphinx-gallery. Define which IPython notebook examples belong in the gallery and confirm that the generated gallery is published successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.