Skip to content

Commit 2b28c08

Browse files
committed
Rename the module to wagtail_polymath
1 parent 91e809f commit 2b28c08

16 files changed

Lines changed: 28 additions & 23 deletions

File tree

.github/workflows/ruff.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,4 @@ jobs:
3434

3535
- name: Run ruff
3636
working-directory: ./src
37-
run: ruff check --output-format=github wagtailmath
37+
run: ruff check --output-format=github wagtail_polymath

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![License: BSD-3-Clause](https://img.shields.io/badge/License-BSD--3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
44
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
5-
[![PyPI version](https://img.shields.io/pypi/v/wagtailmath.svg?style=flat)](https://pypi.org/project/wagtailmath)
5+
[![PyPI version](https://img.shields.io/pypi/v/wagtailmath.svg?style=flat)](https://pypi.org/project/wagtail-polymath)
66
[![Build status](https://img.shields.io/github/actions/workflow/status/wagtail-nest/wagtail-polymath/test.yml?branch=main)](https://github.com/wagtail-nest/wagtail-polymath/actions)
77

88
## Links
@@ -41,9 +41,9 @@ the markup language-specific documentation (e.g. https://en.wikibooks.org/wiki/L
4141

4242
## Quickstart
4343

44-
Install wagtailmath:
44+
Install wagtail_polymath:
4545

46-
pip install wagtailmath
46+
pip install wagtail_polymath
4747

4848
Add it to your `INSTALLED_APPS`:
4949

@@ -52,15 +52,16 @@ Add it to your `INSTALLED_APPS`:
5252

5353
INSTALLED_APPS = (
5454
# ...
55-
"wagtailmath",
55+
"wagtail_polymath",
5656
# ...
5757
)
5858
```
5959

6060
Use `MathBlock` in your `StreamField` content:
6161

6262
```python
63-
from wagtailmath.blocks import MathBlock
63+
from wagtail_polymath.blocks import MathBlock
64+
6465

6566
class MyPage(Page):
6667
body = StreamField([
@@ -74,7 +75,7 @@ Use the `mathjax` template tag in your front end template to load the
7475
MathJax library:
7576

7677
```django+html
77-
{% load wagtailmath %}
78+
{% load wagtail_polymath %}
7879
...
7980
8081
<script src="{% mathjax %}"></script>

pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ requires = ["flit_core >=3.2,<4"]
33
build-backend = "flit_core.buildapi"
44

55
[project]
6-
name = "wagtailmath"
6+
name = "wagtail-polymath"
77
authors = [{name = "James Ramm", email = "jamessramm@gmail.com"}]
88
maintainers = [{name = "Wagtail Nest team", email = "hello@wagtail.org"}]
99
description = "Wagtail StreamField block for rendering mathematical equations"
1010
readme = "README.md"
1111
license = {file = "LICENSE"}
1212
classifiers = [
13-
"Development Status :: 3 - Alpha",
13+
"Development Status :: 4 - Beta",
1414
"Intended Audience :: Developers",
1515
"License :: OSI Approved :: BSD License",
1616
"Operating System :: OS Independent",
@@ -53,7 +53,7 @@ Changelog = "https://github.com/wagtail-nest/wagtail-polymath/blob/main/CHANGELO
5353
Documentation = "https://github.com/wagtail-nest/wagtail-polymath/blob/main/docs/"
5454

5555
[tool.flit.module]
56-
name = "wagtailmath"
56+
name = "wagtail_polymath"
5757

5858
[tool.flit.sdist]
5959
exclude = [

src/wagtail_polymath/apps.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
from django.apps import AppConfig
2+
3+
4+
class WagtailPolymathConfig(AppConfig):
5+
name = "wagtail_polymath"

src/wagtailmath/static/wagtailmath/js/wagtailmath-mathjax-controller.js renamed to src/wagtail_polymath/static/wagtail_polymath/js/wagtail_polymath-mathjax-controller.js

File renamed without changes.

src/wagtailmath/static/wagtailmath/js/wagtailmath.js renamed to src/wagtail_polymath/static/wagtail_polymath/js/wagtail_polymath.js

File renamed without changes.

src/wagtailmath/templates/wagtailmath/mathjaxwidget.html renamed to src/wagtail_polymath/templates/wagtail_polymath/mathjaxwidget.html

File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)