Skip to content

Commit 9a14c66

Browse files
tomicaprettoGStechschulte
authored andcommitted
Update quartodoc to fix CI (bambinos#720)
* Update quartodoc to fix CI * drop official support for python 3.8 * update changelog * remove nonexisting target version * update pylint and some of its options
1 parent 26dc64c commit 9a14c66

11 files changed

+23
-28
lines changed

.github/workflows/publish-docs.yml

+1-2
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,7 @@ jobs:
3030
- name: Install quartodoc and griffe
3131
run: |
3232
python -m pip install --upgrade pip
33-
python -m pip install quartodoc==0.4.2
34-
python -m pip install griffe==0.32.3
33+
python -m pip install quartodoc==0.6.1
3534
3635
- name: Set up Quarto
3736
uses: quarto-dev/quarto-actions/setup@v2

.github/workflows/test.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
runs-on: ubuntu-latest
1212
strategy:
1313
matrix:
14-
python-version: ["3.8", "3.9", "3.10"]
14+
python-version: ["3.9", "3.10", "3.11"]
1515

1616
name: Set up Python ${{ matrix.python-version }}
1717
steps:

.pylintrc

+1-9
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,7 @@ disable=missing-docstring,
6161
too-many-locals,
6262
too-many-branches,
6363
too-many-statements,
64-
no-self-use,
6564
too-few-public-methods,
66-
bad-continuation,
6765
cyclic-import # There was a false positive when working on #607
6866

6967

@@ -132,12 +130,6 @@ max-line-length=100
132130
# Maximum number of lines in a module
133131
max-module-lines=1000
134132

135-
# List of optional constructs for which whitespace checking is disabled. `dict-
136-
# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}.
137-
# `trailing-comma` allows a space between comma and closing bracket: (a, ).
138-
# `empty-line` allows space-only lines.
139-
no-space-check=trailing-comma,
140-
dict-separator
141133

142134
# Allow the body of a class to be on the same line as the declaration if body
143135
# contains single statement.
@@ -259,7 +251,7 @@ good-names=b,
259251
ok,
260252
sd,
261253
tr,
262-
eta,
254+
eta,
263255
Run,
264256
_log,
265257
_,

CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,14 @@
1010

1111
### Maintenance and fixes
1212

13+
* Bump `quartodoc` version to 0.6.1 (#720)
14+
1315
### Documentation
1416

1517
### Deprecation
1618

19+
* Drop official suport for Python 3.8 (#720)
20+
1721

1822
## 0.12.0
1923

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Bambi is a high-level Bayesian model-building interface written in Python. It's
1313

1414
## Installation
1515

16-
Bambi requires a working Python interpreter (3.8+). We recommend installing Python and key numerical libraries using the [Anaconda Distribution](https://www.anaconda.com/products/individual#Downloads), which has one-click installers available on all major platforms.
16+
Bambi requires a working Python interpreter (3.9+). We recommend installing Python and key numerical libraries using the [Anaconda Distribution](https://www.anaconda.com/products/individual#Downloads), which has one-click installers available on all major platforms.
1717

1818
Assuming a standard Python environment is installed on your machine (including pip), Bambi itself can be installed in one line using pip:
1919

docs/.gitignore

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
/.quarto/
22
_site
3-
api/*
4-
CHANGELOG.md
3+
api/*

docs/_quarto.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ project:
22
type: website
33
output-dir: _site
44
pre-render: pre_render.py
5-
#post-render: post_render.py
5+
post-render: post_render.py
66
resources:
77
- api/**
88

@@ -29,7 +29,7 @@ website:
2929
- text: FAQ
3030
file: faq.qmd
3131
- text: Changelog
32-
file: CHANGELOG.md
32+
file: CHANGELOG.qmd
3333
- icon: github
3434
href: https://github.com/bambinos/bambi
3535

docs/index.qmd

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ social sciences and other disciplines.
2525

2626
## Dependencies
2727

28-
Bambi is tested on Python 3.8+ and depends on ArviZ, formulae, NumPy, pandas and PyMC
28+
Bambi is tested on Python 3.9+ and depends on ArviZ, formulae, NumPy, pandas and PyMC
2929
(see [pyproject.toml](https://github.com/bambinos/bambi/blob/main/pyproject.toml)
3030
for version information).
3131

docs/post_render.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
import os
22

33
# Remove CHANGELOG
4-
os.remove("CHANGELOG.md")
4+
os.remove("CHANGELOG.qmd")

docs/pre_render.py

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
1+
import os
12
import shutil
23

3-
# Copy CHANGELOG file to 'docs'
4+
# Copy CHANGELOG file to 'docs' and change its extension to '.qmd'
45
shutil.copyfile("../CHANGELOG.md", "CHANGELOG.md")
6+
os.rename("CHANGELOG.md", "CHANGELOG.qmd")
57

68
# Remove TOC from it
79
lines = """---
810
toc: false
911
pagetitle: "Changelog"
1012
---
1113
"""
12-
with open("CHANGELOG.md", "r+") as file:
13-
file_data = file.read()
14-
file.seek(0, 0)
15-
file.write(lines + "\n" + file_data)
14+
with open("CHANGELOG.qmd", "r+") as file:
15+
file_data = file.read()
16+
file.seek(0, 0)
17+
file.write(lines + "\n" + file_data)

pyproject.toml

+3-4
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,12 @@ dependencies = [
2828
[project.optional-dependencies]
2929
dev = [
3030
"black==22.3.0",
31-
"griffe==0.32.3",
3231
"ipython>=5.8.0,!=8.7.0",
3332
"pre-commit>=2.19",
34-
"pylint==2.10.2",
33+
"pylint==2.17.5",
3534
"pytest-cov>=2.6.1",
3635
"pytest>=4.4.0",
37-
"quartodoc==0.4.2",
36+
"quartodoc==0.6.1",
3837
"seaborn>=0.9.0",
3938
]
4039
jax = [
@@ -67,4 +66,4 @@ version = {file = "bambi/version.txt"}
6766

6867
[tool.black]
6968
line-length = 100
70-
target-version = ["py38", "py39", "py310"]
69+
target-version = ["py39", "py310"]

0 commit comments

Comments
 (0)