Skip to content

Commit

Permalink
Update quartodoc to fix CI (#720)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
tomicapretto authored Sep 15, 2023
1 parent ae00f26 commit 16b005b
Show file tree
Hide file tree
Showing 11 changed files with 23 additions and 28 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/publish-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,7 @@ jobs:
- name: Install quartodoc and griffe
run: |
python -m pip install --upgrade pip
python -m pip install quartodoc==0.4.2
python -m pip install griffe==0.32.3
python -m pip install quartodoc==0.6.1
- name: Set up Quarto
uses: quarto-dev/quarto-actions/setup@v2
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.8", "3.9", "3.10"]
python-version: ["3.9", "3.10", "3.11"]

name: Set up Python ${{ matrix.python-version }}
steps:
Expand Down
10 changes: 1 addition & 9 deletions .pylintrc
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,7 @@ disable=missing-docstring,
too-many-locals,
too-many-branches,
too-many-statements,
no-self-use,
too-few-public-methods,
bad-continuation,
cyclic-import # There was a false positive when working on #607


Expand Down Expand Up @@ -132,12 +130,6 @@ max-line-length=100
# Maximum number of lines in a module
max-module-lines=1000

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

# Allow the body of a class to be on the same line as the declaration if body
# contains single statement.
Expand Down Expand Up @@ -259,7 +251,7 @@ good-names=b,
ok,
sd,
tr,
eta,
eta,
Run,
_log,
_,
Expand Down
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,14 @@

### Maintenance and fixes

* Bump `quartodoc` version to 0.6.1 (#720)

### Documentation

### Deprecation

* Drop official suport for Python 3.8 (#720)


## 0.12.0

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Bambi is a high-level Bayesian model-building interface written in Python. It's

## Installation

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.
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.

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

Expand Down
3 changes: 1 addition & 2 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/.quarto/
_site
api/*
CHANGELOG.md
api/*
4 changes: 2 additions & 2 deletions docs/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ project:
type: website
output-dir: _site
pre-render: pre_render.py
#post-render: post_render.py
post-render: post_render.py
resources:
- api/**

Expand All @@ -29,7 +29,7 @@ website:
- text: FAQ
file: faq.qmd
- text: Changelog
file: CHANGELOG.md
file: CHANGELOG.qmd
- icon: github
href: https://github.com/bambinos/bambi

Expand Down
2 changes: 1 addition & 1 deletion docs/index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ social sciences and other disciplines.

## Dependencies

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

Expand Down
2 changes: 1 addition & 1 deletion docs/post_render.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import os

# Remove CHANGELOG
os.remove("CHANGELOG.md")
os.remove("CHANGELOG.qmd")
12 changes: 7 additions & 5 deletions docs/pre_render.py
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
import os
import shutil

# Copy CHANGELOG file to 'docs'
# Copy CHANGELOG file to 'docs' and change its extension to '.qmd'
shutil.copyfile("../CHANGELOG.md", "CHANGELOG.md")
os.rename("CHANGELOG.md", "CHANGELOG.qmd")

# Remove TOC from it
lines = """---
toc: false
pagetitle: "Changelog"
---
"""
with open("CHANGELOG.md", "r+") as file:
file_data = file.read()
file.seek(0, 0)
file.write(lines + "\n" + file_data)
with open("CHANGELOG.qmd", "r+") as file:
file_data = file.read()
file.seek(0, 0)
file.write(lines + "\n" + file_data)
7 changes: 3 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,12 @@ dependencies = [
[project.optional-dependencies]
dev = [
"black==22.3.0",
"griffe==0.32.3",
"ipython>=5.8.0,!=8.7.0",
"pre-commit>=2.19",
"pylint==2.10.2",
"pylint==2.17.5",
"pytest-cov>=2.6.1",
"pytest>=4.4.0",
"quartodoc==0.4.2",
"quartodoc==0.6.1",
"seaborn>=0.9.0",
]
jax = [
Expand Down Expand Up @@ -67,4 +66,4 @@ version = {file = "bambi/version.txt"}

[tool.black]
line-length = 100
target-version = ["py38", "py39", "py310"]
target-version = ["py39", "py310"]

0 comments on commit 16b005b

Please sign in to comment.