Skip to content

Commit e3d0866

Browse files
authored
Refactor repo to match ReactPy Router (#216)
1 parent c3eee76 commit e3d0866

21 files changed

+3481
-1080
lines changed

.github/workflows/publish-develop-docs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
name: Publish Develop Docs
2+
23
on:
34
push:
45
branches:
@@ -17,5 +18,6 @@ jobs:
1718
- name: Publish Develop Docs
1819
run: |
1920
git config user.name github-actions
20-
git config user.email github-actions@github.com
21+
git config user.email github-actions@github.com
22+
cd docs
2123
mike deploy --push develop

.github/workflows/publish-py.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jobs:
1313
steps:
1414
- uses: actions/checkout@v3
1515
- name: Set up Python
16-
uses: actions/setup-python@v1
16+
uses: actions/setup-python@v4
1717
with:
1818
python-version: "3.x"
1919
- name: Install dependencies

.github/workflows/publish-release-docs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,6 @@ jobs:
1818
- name: Publish ${{ github.event.release.name }} Docs
1919
run: |
2020
git config user.name github-actions
21-
git config user.email github-actions@github.com
21+
git config user.email github-actions@github.com
22+
cd docs
2223
mike deploy --push --update-aliases ${{ github.event.release.name }} latest

.github/workflows/test-docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ jobs:
2626
linkcheckMarkdown docs/ -v -r
2727
linkcheckMarkdown README.md -v -r
2828
linkcheckMarkdown CHANGELOG.md -v -r
29+
cd docs
2930
mkdocs build --strict
3031
- name: Check docs examples
3132
run: |
3233
pip install -r requirements/check-types.txt
3334
pip install -r requirements/check-style.txt
3435
mypy --show-error-codes docs/examples/python/
35-
black docs/examples/python/ --check
3636
ruff check docs/examples/python/

.github/workflows/test-src.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,4 @@ jobs:
2525
- name: Install Python Dependencies
2626
run: pip install -r requirements/test-run.txt
2727
- name: Run Tests
28-
run: |
29-
nox -s test
28+
run: nox -t test

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -444,7 +444,7 @@ Using the following categories, list your changes in this order:
444444

445445
- Support for IDOM within the Django
446446

447-
[unreleased]: https://github.com/reactive-python/reactpy-django/compare/3.6.0...HEAD
447+
[Unreleased]: https://github.com/reactive-python/reactpy-django/compare/3.6.0...HEAD
448448
[3.6.0]: https://github.com/reactive-python/reactpy-django/compare/3.5.1...3.6.0
449449
[3.5.1]: https://github.com/reactive-python/reactpy-django/compare/3.5.0...3.5.1
450450
[3.5.0]: https://github.com/reactive-python/reactpy-django/compare/3.4.0...3.5.0

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<a href="https://pypi.python.org/pypi/reactpy-django">
88
<img src="https://img.shields.io/pypi/v/reactpy-django.svg?label=PyPI">
99
</a>
10-
<a href="https://github.com/reactive-python/reactpy/blob/main/LICENSE">
10+
<a href="https://github.com/reactive-python/reactpy-django/blob/main/LICENSE.md">
1111
<img src="https://img.shields.io/badge/License-MIT-purple.svg">
1212
</a>
1313
<a href="https://reactive-python.github.io/reactpy-django/">

mkdocs.yml renamed to docs/mkdocs.yml

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ nav:
2525

2626
theme:
2727
name: material
28-
custom_dir: docs/overrides
28+
custom_dir: overrides
2929
palette:
3030
- media: "(prefers-color-scheme: dark)"
3131
scheme: slate
@@ -114,12 +114,11 @@ extra_css:
114114
- assets/css/home.css
115115

116116
watch:
117-
- docs
118-
- mkdocs.yml
119-
- README.md
120-
- CHANGELOG.md
121-
- LICENSE.md
122-
- .mailmap
117+
- ../docs
118+
- ../README.md
119+
- ../CHANGELOG.md
120+
- ../LICENSE.md
121+
- ../.mailmap
123122

124123
site_name: ReactPy-Django
125124
site_author: Archmonger
@@ -133,6 +132,6 @@ This project has no affiliation to ReactJS or Meta Platforms, Inc.
133132
</div>'
134133
repo_url: https://github.com/reactive-python/reactpy-django
135134
site_url: https://reactive-python.github.io/reactpy-django
136-
repo_name: reactive-python/reactpy-django
135+
repo_name: ReactPy Django (GitHub)
137136
edit_uri: edit/main/docs/src
138-
docs_dir: docs/src
137+
docs_dir: src

docs/src/about/code.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,13 @@ pip install -r requirements.txt --upgrade --verbose
5252
By running the command below you can run the full test suite:
5353

5454
```bash linenums="0"
55-
nox -s test
55+
nox -t test
5656
```
5757

5858
Or, if you want to run the tests in the background:
5959

6060
```bash linenums="0"
61-
nox -s test -- --headless
61+
nox -t test -- --headless
6262
```
6363

6464
## Running Django tests

docs/src/about/docs.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ pip install -r requirements.txt --upgrade
3434
Finally, to verify that everything is working properly, you can manually run the docs preview web server.
3535

3636
```bash linenums="0"
37+
cd docs
3738
mkdocs serve
3839
```
3940

0 commit comments

Comments
 (0)