jupyter / jupyter/nbconvert

Is there currently a way to navigate documentation through a network of notebooks interface?

Open
#116 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.9k
Forks
616
Avg merge
2h 11m
Merged PRs (30d)
1

Description

This would seem to fall into an advanced application into the domain of nbconvert preprocessing (I think).

Where one is going from a file-hierarchy of documentation files in a way that acts as sphinx for the notebook rather than for the internet. Or is that the riddle?

Are there other examples of open-source interactive, code-example based documentation editing engines from which some system like this could derive lessons?

A great documentation editor would make it much more interesting for people to edit documentation. Because they can be writing code at the same time, editing documentation could be an excellent opportunity to sharpen your coding skills and be sure that you are up to date about relatively novel techniques, since you can receive further corrections by other contributors with different expertises by virtue of the documentation being open-source.

If there is no such engine, what user interface notions should I acquaint myself with if I wanted to build a way to just edit and navigate python documentation(e.g., that of nbconvert) in a convenient notebook interface?

@sbenthall are there any good user interface paradigms for social graph munging (in the data plumbing sense, not the destructive systems-data munging sense)?

Contributor guide

Open the contributing guide

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 nbconvert preprocessing and the existing notebook documentation structure mentioned in the issue. Compare open-source interactive, code-example-based documentation editors and notebook navigation interfaces. Done would require a concrete proposal defining the interface, documentation workflow, and implementation scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter, jupyter-notebook, python
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.