Skip to content

Commit 29503e3

Browse files
committed
style: reformatted with prettier
1 parent 19207de commit 29503e3

File tree

4 files changed

+27
-23
lines changed

4 files changed

+27
-23
lines changed

.github/workflows/sphinx-gh-pages.yaml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,21 +31,21 @@ jobs:
3131
- name: Set up Python
3232
uses: actions/setup-python@v4
3333
with:
34-
python-version: '3.11'
35-
cache: 'pip'
34+
python-version: "3.11"
35+
cache: "pip"
3636
- name: Install tox
3737
run: pip install tox
3838
- name: Build with Sphinx
3939
run: tox -e docs
4040
- name: Upload artifact
4141
uses: actions/upload-pages-artifact@v2.0.0
4242
# with:
43-
# Artifact name
44-
# name: # optional, default is github-pages
45-
# Path of the directory containing the static assets.
46-
# path: # default is _site/
47-
# Duration after which artifact will expire in days.
48-
# retention-days: # optional, default is 1
43+
# Artifact name
44+
# name: # optional, default is github-pages
45+
# Path of the directory containing the static assets.
46+
# path: # default is _site/
47+
# Duration after which artifact will expire in days.
48+
# retention-days: # optional, default is 1
4949

5050
# Deployment job
5151
deploy:

.github/workflows/tests.yml

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ name: Tests
55

66
on:
77
push:
8-
branches: [ "*" ]
8+
branches: ["*"]
99
pull_request:
10-
branches: [ "*" ]
10+
branches: ["*"]
1111
workflow_dispatch:
1212

1313
permissions:
@@ -17,15 +17,15 @@ jobs:
1717
test:
1818
runs-on: ubuntu-latest
1919
steps:
20-
- uses: actions/checkout@v3
21-
- name: Set up Python
22-
uses: actions/setup-python@v3
23-
with:
24-
python-version: "3.11"
25-
- name: Install dependencies
26-
run: |
27-
python -m pip install --upgrade pip
28-
pip install tox==4.11.3
29-
- name: Test
30-
run: |
31-
tox
20+
- uses: actions/checkout@v3
21+
- name: Set up Python
22+
uses: actions/setup-python@v3
23+
with:
24+
python-version: "3.11"
25+
- name: Install dependencies
26+
run: |
27+
python -m pip install --upgrade pip
28+
pip install tox==4.11.3
29+
- name: Test
30+
run: |
31+
tox

.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs/_templates/layout.html

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,12 @@
55
# sphinx-reredirects
66

77
<!-- Major intro -->
8+
89
**The sphinx-reredirects is the extension for Sphinx documentation projects that handle redirects for moved pages. It generates HTML pages with meta refresh redirects to the new page location to prevent 404 errors if you rename or move your documents.**
910

1011
<!-- Minor intro -->
1112

12-
The sphinx-reredirects started from the urge to manage redirects for all documents after moving our *Tech writer at work* blog to the new address at https://documatt.com/blog/.
13+
The sphinx-reredirects started from the urge to manage redirects for all documents after moving our _Tech writer at work_ blog to the new address at https://documatt.com/blog/.
1314

1415
<!-- Highlights in points -->
1516
<p>
@@ -43,9 +44,11 @@ The sphinx-reredirects started from the urge to manage redirects for all documen
4344
[![PyPI version](https://img.shields.io/pypi/v/sphinx-reredirects?labelColor=097cba&color=163B36)](https://pypi.org/project/sphinx-reredirects/)
4445
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sphinx-reredirects?labelColor=097cba&color=163B36)](https://pypi.org/project/sphinx-reredirects/)
4546
[![MIT licence](https://img.shields.io/badge/license-MIT-blue?labelColor=097cba&color=163B36)](https://raw.githubusercontent.com/documatt/sphinx-reredirects/refs/heads/main/LICENSE)
47+
4648
</div>
4749

4850
<!-- Very short intro -->
51+
4952
Good URLs are never changing URLs. But if you must, sphinx-reredirects helps you manage redirects with ease and from a single place in the project's `conf.py`.
5053

5154
For example, if you rename document `start` to `intro`, and tell it to sphinx-reredirects, it will generate the HTML page `start.html` with `<meta http-equiv="refresh" content="0; url=intro.html">`.

0 commit comments

Comments
 (0)