Skip to content

Commit 1fb8044

Browse files
gviejogviejo
authored
Merge pull request #19 from pynapple-org/cleaning
Cleaning
2 parents e033187 + 41c76b7 commit 1fb8044

36 files changed

+635
-1117
lines changed

‎.github/workflows/ci.yml‎

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,23 +29,29 @@ jobs:
2929
uses: actions/setup-python@v4 # Use v4 for compatibility with pyproject.toml
3030
with:
3131
python-version: ${{ matrix.python-version }}
32-
cache: pip
3332

34-
- name: Install dependencies
33+
- name: Install llvmpipe and lavapipe for offscreen canvas
3534
run: |
36-
python -m pip install --upgrade pip
37-
python -m pip install .[dev]
35+
sudo apt-get update -y -qq
36+
sudo apt-get install --no-install-recommends -y \
37+
ffmpeg \
38+
libegl-mesa0 \
39+
libgl1-mesa-dri \
40+
libxcb-xfixes0-dev \
41+
mesa-vulkan-drivers
3842
43+
- name: Install dependencies
44+
run: |
45+
python -m pip install --upgrade pip setuptools
46+
python -m pip install ".[dev]"
3947
- name: Run nox
4048
run: |
41-
nox
42-
43-
# - name: Coveralls
44-
# env:
45-
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
46-
# run: |
47-
# pip install coveralls
48-
# coveralls --service=github
49+
nox --no-venv -s linters
50+
- name: Test examples
51+
env:
52+
PYGFX_EXPECT_LAVAPIPE: true
53+
run: |
54+
WGPU_FORCE_OFFSCREEN=1 pytest -v tests/
4955
5056
check:
5157
if: always()

‎docs/README.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Building the pynaviz documentation
2+
===========
3+
4+
`pip install pynaviz[docs]`
5+
6+
`pip install sphinx-autobuild`
7+
8+
In doc:
9+
10+
`sphinx-autobuild . _build/html`
11+

‎docs/_static/CCN-logo-wText.png‎

50.8 KB
Loading

‎docs/_static/custom.css‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
2+
.bd-main .bd-content .bd-article-container{
3+
max-width:100%;
4+
flex-grow: 1;
5+
}
6+
7+
html[data-theme=light]{
8+
--pst-color-primary: rgb(52, 54, 99);
9+
--pst-color-secondary: rgb(107, 161, 174);
10+
--pst-color-link: rgb(74, 105, 145);
11+
--pst-color-inline-code: rgb(96, 141, 130);
12+
}
13+
14+
:root {
15+
--pst-font-size-h1: 38px;
16+
--pst-font-size-h2: 32px;
17+
--pst-font-size-h3: 27px;
18+
--pst-font-size-h4: 22px;
19+
--pst-font-size-h5: 18px;
20+
--pst-font-size-h6: 15px;
21+
}

‎docs/_static/logo_flatiron_white.svg‎

Lines changed: 206 additions & 0 deletions
Loading

‎docs/_templates/autosummary/class.rst‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{{ fullname | escape | underline}}
2+
3+
.. currentmodule:: {{ module }}
4+
5+
.. autoclass:: {{ objname }}
6+
:members:
7+
:inherited-members:
8+
9+
{% block methods %}
10+
.. automethod:: __init__
11+
12+
{% if methods %}
13+
.. rubric:: Methods
14+
15+
.. autosummary::
16+
:toctree: ./
17+
{% for item in methods %}
18+
~{{ name }}.{{ item }}
19+
{%- endfor %}
20+
{% endif %}
21+
{% endblock %}
22+
23+
{% block attributes %}
24+
{% if attributes %}
25+
.. rubric:: Attributes
26+
27+
.. autosummary::
28+
{% for item in attributes %}
29+
~{{ name }}.{{ item }}
30+
{%- endfor %}
31+
{% endif %}
32+
{% endblock %}

‎docs/_templates/layout.html‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{% extends "!layout.html" %}
2+
3+
{%- block footer %}
4+
<footer class="footer" style="border-top: 1px solid #ccc; padding-top: 10px">
5+
<div class="container">
6+
<div id="credits" style="width: 50%; float: left">
7+
<p>
8+
{% trans copyright=copyright|e %}&#169; Copyright {{ copyright }}, <a href="https://www.simonsfoundation.org/people/guillaume-viejo/">pynapple authors</a>.{% endtrans %}<br/>
9+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/">PyData Theme</a>.<br/>
10+
</p>
11+
</div>
12+
<div id="version" style="color: #999; float: right; margin: 15px">v{{ version }}</div>
13+
</div>
14+
</div>
15+
</footer>
16+
{%- endblock %}

‎docs/_templates/version.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<div id="version" class="navbar-start-item" style="color: #bbb">
2+
{{ version }}
3+
</div>

‎docs/api.rst‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
.. _api_ref:
2+
3+
API reference
4+
=============
5+
6+
.. rubric:: Base plot
7+
8+
.. currentmodule:: pynaviz.base_plot
9+
10+
.. autosummary::
11+
:toctree: generated/
12+
:nosignatures:
13+
:recursive:
14+
15+
PlotTsd
16+
PlotTsdFrame
17+
PlotTsdTensor
18+
PlotTs
19+
PlotTsGroup
20+
21+
.. rubric:: Custom controllers
22+
23+
.. currentmodule:: pynaviz.controller
24+
25+
.. autosummary::
26+
:toctree: generated/
27+
:nosignatures:
28+
:recursive:
29+
30+
SpanController
31+
GetController
32+
33+
.. rubric:: Pynaviz
34+
35+
.. currentmodule:: pynaviz
36+
37+
.. autosummary::
38+
:toctree: generated/
39+
:nosignatures:
40+
:recursive:
41+
42+
base_plot
43+
controller
44+
events
45+
interval_set
46+
plot_manager
47+
qt_item_models
48+
widget_plot
49+
widget_menu
50+
utils
51+
synchronization_rules

0 commit comments

Comments
 (0)