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 — Fill out the documentation by jim22k · Pull Request #268 · python-graphblas/python-graphblas

Conversation

@jim22k

@jim22k jim22k commented Jul 6, 2022

Copy link
Copy Markdown
Member

This uses sphinx with the pydata_sphinx_theme for styling.

The goal for this first cut is correct documentation covering most of the library to get users started. More work is expected in the future to cover all the corner cases, but we can't let perfection become the enemy of progress.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
jim22k added 4 commits June 29, 2022 17:08
@jim22k
Framework for docs
ca97e1c 
- Update main landing page
- Build Getting Started page
- Placeholder for User Guide, API Ref, and Contributor Guide
@jim22k
More doc updates
4618759
@jim22k
Merge branch 'main' into docs
a5a202b
@jim22k
More doc updates
b12fd20
@jim22k
jim22k requested a review from eriknw July 6, 2022 18:49
@eriknw

eriknw commented Jul 6, 2022

Copy link
Copy Markdown
Member

yay 🎉

I love this so much.

I'm not sure why the style checks fail on CI but pass pre-commit. Perhaps we should simply run pre-commit in CI. I have a fix for the flake8 errors in this PR: #267
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
jim22k added 3 commits July 7, 2022 13:30
@jim22k
Fill in more pages in the user guide
26e2ccc
@jim22k
Merge branch 'main' into docs
c551454
@jim22k
Fix formatting in conf.py
82f454c
@coveralls

coveralls commented Jul 8, 2022 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown

Coverage Status

Coverage decreased (-0.2%) to 99.176% when pulling 8ad7b44 on jim22k:docs into ef4b1ca on python-graphblas:main.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
jim22k added 2 commits July 8, 2022 18:39
@jim22k
User Guide is ready
2168cb9
@jim22k
Add placeholders for API ref and Contributor guide
8ad7b44
@jim22k
jim22k merged commit 49d6e02 into python-graphblas:main Jul 9, 2022
@jim22k jim22k changed the title [WIP] Fill out the documentation Fill out the documentation Jul 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@eriknw eriknw Awaiting requested review from eriknw

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@jim22k @eriknw @coveralls
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.