Skip to content

Commit 0383460

Browse files
sdpythonsdpython
committed
first draft
1 parent 7d3263d commit 0383460

28 files changed

+1415
-0
lines changed

‎.github/workflows/black.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name: Black Format Checker
2+
on: [push, pull_request]
3+
jobs:
4+
black-format-check:
5+
runs-on: ubuntu-latest
6+
steps:
7+
- uses: actions/checkout@v2
8+
- uses: psf/black@stable
9+
with:
10+
options: "--diff --check"
11+
src: "."

‎.github/workflows/documentation.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Documentation
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
build_wheels:
7+
name: Build documentation on ${{ matrix.os }}
8+
runs-on: ${{ matrix.os }}
9+
strategy:
10+
matrix:
11+
os: [ubuntu-latest]
12+
13+
steps:
14+
- uses: actions/checkout@v3
15+
16+
# Used to host cibuildwheel
17+
- uses: actions/setup-python@v4
18+
with:
19+
python-version: '3.10'
20+
21+
- name: Install requirements
22+
run: python -m pip install -r requirements.txt
23+
24+
- name: Install requirements-dev.txt
25+
run: python -m pip install -r requirements-dev.txt
26+
27+
- name: Install
28+
run: python -m pip install -e .
29+
30+
- name: Documentation
31+
run: python -m sphinx ./_doc ./dist/html
32+
33+
- uses: actions/upload-artifact@v3
34+
with:
35+
path: ./dist/html/**

‎.github/workflows/wheels-linux.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Build Wheel Linux
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- 'releases/**'
8+
9+
jobs:
10+
build_wheels:
11+
name: Build wheels on ${{ matrix.os }}
12+
runs-on: ${{ matrix.os }}
13+
strategy:
14+
matrix:
15+
os: [ubuntu-latest]
16+
17+
steps:
18+
- uses: actions/checkout@v3
19+
20+
# Used to host cibuildwheel
21+
- uses: actions/setup-python@v4
22+
with:
23+
python-version: '3.10'
24+
25+
- name: Install cibuildwheel
26+
run: python -m pip install cibuildwheel
27+
28+
- name: python version
29+
run: python -V
30+
31+
- name: Build wheels
32+
run: python -m cibuildwheel --output-dir wheelhouse
33+
# to supply options, put them in 'env', like:
34+
#env:
35+
# # CIBW_BUILD: "cp310* cp311*"
36+
# CIBW_SKIP: cp36-* cp37-* cp38-* cp39-*
37+
38+
- uses: actions/upload-artifact@v3
39+
with:
40+
path: ./wheelhouse/*.whl

‎.github/workflows/wheels-mac.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Build Wheel MacOS
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- 'releases/**'
8+
9+
jobs:
10+
build_wheels:
11+
name: Build wheels on ${{ matrix.os }}
12+
runs-on: ${{ matrix.os }}
13+
strategy:
14+
matrix:
15+
os: [macOS-latest]
16+
17+
steps:
18+
- uses: actions/checkout@v3
19+
20+
# Used to host cibuildwheel
21+
- uses: actions/setup-python@v4
22+
with:
23+
python-version: '3.10'
24+
25+
- name: Install cibuildwheel
26+
run: python -m pip install cibuildwheel
27+
28+
- name: python version
29+
run: python -V
30+
31+
- name: Build wheels
32+
run: python -m cibuildwheel --output-dir wheelhouse
33+
# to supply options, put them in 'env', like:
34+
#env:
35+
# CIBW_BUILD: cp311*
36+
37+
- uses: actions/upload-artifact@v3
38+
with:
39+
path: ./wheelhouse/*.whl

‎.github/workflows/wheels-windows.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Build Wheel Windows
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- 'releases/**'
8+
9+
jobs:
10+
build_wheels:
11+
name: Build wheels on ${{ matrix.os }}
12+
runs-on: ${{ matrix.os }}
13+
strategy:
14+
matrix:
15+
os: [windows-latest]
16+
17+
steps:
18+
- uses: actions/checkout@v3
19+
20+
# Used to host cibuildwheel
21+
- uses: actions/setup-python@v4
22+
with:
23+
python-version: '3.10'
24+
25+
- name: Install cibuildwheel
26+
run: python -m pip install cibuildwheel
27+
28+
- name: python version
29+
run: python -V
30+
31+
- name: Build wheels
32+
run: python -m cibuildwheel
33+
# to supply options, put them in 'env', like:
34+
# env:
35+
# CIBW_BUILD: cp310-win_amd64* cp311-win_amd64*
36+
37+
- uses: actions/upload-artifact@v3
38+
with:
39+
path: ./wheelhouse/*.whl

‎.gitignore‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
*.pyc
2+
*.pyd
3+
*.dylib
4+
*.so
5+
coverage.html/*
6+
_cache/*
7+
.coverage
8+
dist/*
9+
build/*
10+
.eggs/*
11+
*egg-info/*
12+
_doc/examples/_cache/*
13+
_doc/auto_examples/*
14+
_doc/examples/plot_*.png
15+
_doc/_static/require.js
16+
_doc/_static/viz.js
17+
_unittests/ut__main/*.png
18+
_doc/examples/*.html
19+
_unittests/ut__main/_cache/*
20+
_unittests/ut__main/*.html

‎CHANGELOGS.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Change Logs
2+
===========
3+
4+
0.1.0
5+
+++++
6+
7+
* :pr:`5`: ***

‎MANIFEST.in‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
prune _doc
2+
prune _unittests
3+
exclude *.bat
4+
exclude *.yml
5+
exclude *.git*

‎README.rst‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
2+
.. image:: https://github.com/sdpython/sphinx-runpython/raw/main/_doc/_static/logo.png
3+
:width: 120
4+
5+
sphinx-runpython: run python code in sphinx
6+
===========================================
7+
8+
.. image:: https://dev.azure.com/xavierdupre3/sphinx-runpython/_apis/build/status/sdpython.sphinx-runpython
9+
:target: https://dev.azure.com/xavierdupre3/sphinx-runpython/
10+
11+
.. image:: https://badge.fury.io/py/sphinx-runpython.svg
12+
:target: http://badge.fury.io/py/sphinx-runpython
13+
14+
.. image:: http://img.shields.io/github/issues/sdpython/sphinx-runpython.png
15+
:alt: GitHub Issues
16+
:target: https://github.com/sdpython/sphinx-runpython/issues
17+
18+
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
19+
:alt: MIT License
20+
:target: http://opensource.org/licenses/MIT
21+
22+
.. image:: https://img.shields.io/github/repo-size/sdpython/sphinx-runpython
23+
:target: https://github.com/sdpython/sphinx-runpython/
24+
:alt: size
25+
26+
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
27+
:target: https://github.com/psf/black
28+
29+
**sphinx-runpython** implements sphinx extensions including one
30+
to execute code and add the output to the documentation.
31+
32+
The library is released on
33+
`pypi/sphinx-runpython <https://pypi.org/project/sphinx-runpython/>`_
34+
and its documentation is published at
35+
`sphinx-runpython
36+
<http://www.xavierdupre.fr/app/sphinx-runpython/helpsphinx/index.html>`_.

‎_doc/_static/logo.png‎

1008 Bytes
Loading

0 commit comments

Comments
 (0)