GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — [pyos][docs] Link to or include example notebooks in docs · Issue #407 · python-graphblas/python-graphblas

[pyos][docs] Link to or include example notebooks in docs #407

New issue
Copy link
New issue
Copy link
Open
Open
[pyos][docs] Link to or include example notebooks in docs#407
Copy link
Labels
documentationImprove or add to documentationImprove or add to documentation

Description

@sneakers-the-rat
sneakers-the-rat
opened on Mar 20, 2023
Issue body actions

Approaching the package as a naïve potential user, I was looking for some examples after the 'getting started' section. Would recommend linking to the example notebooks as an entry in the Getting Started toctree: https://github.com/python-graphblas/python-graphblas/blob/main/docs/getting_started/index.rst

It's possible to put HTTP links directly in the toctree, or else you could render the notebooks themselves using an extension, eg.: https://docs.readthedocs.io/en/stable/guides/jupyter.html

Part of pyOpenSci/software-submission#81

Reacted by Szabolcs Horvát

Activity

  1. eriknw
    added
    documentationImprove or add to documentationImprove or add to documentation
    on Mar 25, 2023
  2. eriknw commented on Apr 26, 2023

    @eriknw
    eriknw
    on Apr 26, 2023
    Member
    More actions

    Thanks for the suggestions and pointers. Example notebooks in the docs sound great to me. We should probably give the existing notebooks some attention and revise them as appropriate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprove or add to documentationImprove or add to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      You are visitor 01402503 — GeezerVison does not store the pages you look up.
      Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.