Skip to content

Commit

Permalink
[WIP] Fill out the documentation (python-graphblas#268)
Browse files Browse the repository at this point in the history
* Update docs

- Update main landing page
- Build Getting Started page
- Build User Guide
- Placeholder for API Ref and Contributor Guide
  • Loading branch information
jim22k authored Jul 9, 2022
1 parent ef4b1ca commit 49d6e02
Show file tree
Hide file tree
Showing 39 changed files with 2,506 additions and 214 deletions.
54 changes: 54 additions & 0 deletions docs/_static/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@

/* Main Page Stylings */

.container-xl {
max-width: 1400px;
}

.intro-card {
margin-bottom: 30px;
}

.intro-card:hover {
box-shadow: 0.2rem 0.5rem 1rem var(--pst-color-link) !important;
}

.intro-card .card-header {
background-color: inherit;
}

.intro-card .card-header .card-text {
font-weight: bold;
}

.intro-card .card-body {
margin-top: 0;
}

.intro-card .card-body .card-text:first-child {
margin-bottom: 0;
}

.shadow {
box-shadow: 0.2rem 0.5rem 1rem var(--pst-color-text-muted) !important;
}

.table {
font-size: smaller;
width: inherit;
}

.table td, .table th {
padding: 0 .75rem;
}

.table.inline {
display: inline-table;
margin-right: 30px;
}

/* Styling for Jupyter Notebook ReST Exports */

.dataframe tbody th, .dataframe tbody td {
padding: 10px;
}
File renamed without changes.
Binary file added docs/_static/img/GraphBLAS-API-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/img/GraphBLAS-mapping.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/img/Matrix-A-strictly-upper.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/img/Matrix-A-upper.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/img/Recorder-output.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/img/adj-graph.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/_static/img/directed-graph.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/img/min-plus-semiring.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/img/plus-times-semiring.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/img/repr-matrix.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/img/repr-scalar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/img/repr-vector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/_static/img/social-network.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/img/sssp-result.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/_static/img/super-simple.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/_static/img/task-graph.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 49d6e02

Please sign in to comment.