Skip to content

Commit

Permalink
Updating docs, fixing errors in readme, preparing version 0.51
Browse files Browse the repository at this point in the history
  • Loading branch information
kecho committed Sep 17, 2023
1 parent 5d55d00 commit f91267f
Show file tree
Hide file tree
Showing 7 changed files with 1,396 additions and 11 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,7 @@ t2-output
tags
imgui.ini
.shader_pdb
*/__pycache__
*/*/__pycache__
*/*/*/__pycache__
docs/_site/*
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ Compute abstraction layer for python.
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Build Status](https://github.com/kecho/coalpy/actions/workflows/ci.yaml/badge.svg)](https://github.com/kecho/coalpy/actions/workflows/ci.yaml)

[CoalPy](https://coalpy.org) is a free low friction python (3.9, 3.10, 3.11) native module for Windows and Linux. Coalpy's main goal is to make modern DirectX12 or Vulkan GPU compute software easy to write and deploy.
[CoalPy](https://coalpy.org) is a free low friction python (3.10, 3.11) native module for Windows and Linux. Coalpy's main goal is to make modern DirectX12 or Vulkan GPU compute software easy to write and deploy.

![seascape_example](docs/images/seascape.png?raw=true "Seascape shadertoy by Alexander Alekseev aka TDM - 2014.")

## Python module

Get started with API documentation here:
[coalpy.gpu documentation](https://kecho.github.io/coalpy/coalpy.gpu.html)
[coalpy.gpu documentation](https://coalpy.org/apidocs/0.51/coalpy.gpu.html)

To install, just run the pip command:

Expand All @@ -34,7 +34,7 @@ The following section specifies guidelines for contributing to the coalpy projec
### Building requirements
* Install Python supported versions
** Preferably [3.11](https://www.python.org/downloads/release/python-3112/)
** Other versions include 3.9 and 3.10
** Other versions include 3.10
* Ensure you have a version of visual studio with support for VC
* Ensure you are on the latest and greatest version of windows 10

Expand Down
4 changes: 2 additions & 2 deletions Source/pipfiles/setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[metadata]
name = coalpy
version = 0.50
version = 0.51
author = Kleber A Garcia
author_email = [email protected]
description = CoalPy - Compute Abstraction Layer for Python.
Expand All @@ -20,7 +20,7 @@ include_package_data = True
packages = coalpy, coalpy.examples
package_dir =
=src
python_requires = >=3.9
python_requires = >=3.10

[options.packages.find]
where=src
2 changes: 1 addition & 1 deletion docs/_data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ main:
- title: Tutorial
url: /tutorial-intro
- title: API Docs
url: /apidocs/0.50/coalpy.gpu.html
url: /apidocs/0.51/coalpy.gpu.html
- title: GitHub
url: https://github.com/kecho/coalpy

Expand Down
1,294 changes: 1,294 additions & 0 deletions docs/apidocs/0.51/coalpy.gpu.html

Large diffs are not rendered by default.

93 changes: 93 additions & 0 deletions docs/apidocs/0.51/coalpy_docs_style.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
html
{
background-color: #252a34;
color: #fff;
}

.content
{
min-width: inherit;
padding-left: 490px;
}

.sidebar
{
display: block;
cursor: pointer;
float: left;
width: 440px;
height: 100%;
position: fixed;
overflow-y: auto;
margin-left: 20px;
padding-right: 20px;
}

.sidebar ul
{
list-style-type: none;
}

.treedot
{
float: left;
color:#00ff03;
margin-right:10px;
}

.treelink
{
color:#b7b7ff;
}

.treename
{
}

.membertable
{
font-size:12px;
}

.h3title
{
color:#b7b7ff;
padding-top:20px;
font-size:20px;
}

.subtitle
{
color:#00ff03;
font-size:12px;
}

.header-root
{
width: 100%;
height: 40px;
position: fixed;
color:#b7b7ff;
background-color: #2c2c51;
z-index:30;
padding-top:0px;
padding-top: 8px;
}

body
{
margin-top: 0px;
margin-right: 0px;
margin-bottom: 0px;
margin-left: 0px;
font-family: 'Consolas';
}

.body-root
{
padding-top: 40px;
padding-right: 0px;
padding-bottom: 10px;
padding-left: 0px;
z-index:40;
}
5 changes: 0 additions & 5 deletions docs/todos.txt

This file was deleted.

0 comments on commit f91267f

Please sign in to comment.