Skip to content

Commit e27fff2

Browse files
committed
v1.5.1
--------- 2024-02-28: - overhaul documentation - github actions/checkout@v4 - github actions/setup-python@v5
1 parent d28da79 commit e27fff2

File tree

2 files changed

+62
-62
lines changed

2 files changed

+62
-62
lines changed

.docs/usage.rst

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
1-
- `Basic Usage`_
2-
- `General Recommendations`_
3-
- `use with Windows`_
4-
- `Quick Guide for the Eager`_
5-
- `In-Depth Explanation for the Curious`_
6-
- `Windows Compatibility Issue`_
7-
- `Timing Considerations`_
8-
- `Considerations using Signals`_
9-
- `Considerations using Subprocesses`_
10-
- `Overview`_
11-
- `Initialization`_
12-
- `Process Execution and Communication`_
13-
- `Subprocess Start Methods`_
14-
- `Choosing the Right Start Method`_
15-
- `Setting the Start Method`_
16-
- `Special Considerations for Uvicorn, FastAPI, asyncio`_
17-
- `Handling Nested Timeouts`_
18-
- `Custom Timeout Exception`_
19-
- `Parameters`_
20-
- `Override Parameters`_
21-
- `Multithreading`_
22-
- `Subprocess Monitoring`_
23-
- `use as function not as decorator`_
24-
- `Dynamic Timeout Value Adjustment with eval`_
25-
- `Tools`_
26-
- `detect pickle errors`_
27-
- `set_subprocess_starting_method`_
28-
- `Logging Challenges with Subprocesses`_
29-
- `hard timeout`_
30-
- `Understanding Timeout Durations Across Platforms`_
31-
- `MYPY Testing`_
1+
- `Basic Usage`_
2+
- `General Recommendations`_
3+
- `use with Windows`_
4+
- `Quick Guide for the Eager`_
5+
- `In-Depth Explanation for the Curious`_
6+
- `Windows Compatibility Issue`_
7+
- `Timing Considerations`_
8+
- `Considerations using Signals`_
9+
- `Considerations using Subprocesses`_
10+
- `Overview`_
11+
- `Initialization`_
12+
- `Process Execution and Communication`_
13+
- `Subprocess Start Methods`_
14+
- `Choosing the Right Start Method`_
15+
- `Setting the Start Method`_
16+
- `Special Considerations for Uvicorn, FastAPI, asyncio`_
17+
- `Handling Nested Timeouts`_
18+
- `Custom Timeout Exception`_
19+
- `Parameters`_
20+
- `Override Parameters`_
21+
- `Multithreading`_
22+
- `Subprocess Monitoring`_
23+
- `use as function not as decorator`_
24+
- `Dynamic Timeout Value Adjustment with eval`_
25+
- `Tools`_
26+
- `detect pickle errors`_
27+
- `set_subprocess_starting_method`_
28+
- `Logging Challenges with Subprocesses`_
29+
- `hard timeout`_
30+
- `Understanding Timeout Durations Across Platforms`_
31+
- `MYPY Testing`_
3232

3333
.. include:: ./parts/01_basic_usage.rst
3434
.. include:: ./parts/02_general_recommendations.rst

README.rst

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -140,37 +140,37 @@ repository_slug}}/master?filepath=wrapt_timeout_decorator.ipynb>`_
140140
Usage
141141
-----------
142142

143-
- `Basic Usage`_
144-
- `General Recommendations`_
145-
- `use with Windows`_
146-
- `Quick Guide for the Eager`_
147-
- `In-Depth Explanation for the Curious`_
148-
- `Windows Compatibility Issue`_
149-
- `Timing Considerations`_
150-
- `Considerations using Signals`_
151-
- `Considerations using Subprocesses`_
152-
- `Overview`_
153-
- `Initialization`_
154-
- `Process Execution and Communication`_
155-
- `Subprocess Start Methods`_
156-
- `Choosing the Right Start Method`_
157-
- `Setting the Start Method`_
158-
- `Special Considerations for Uvicorn, FastAPI, asyncio`_
159-
- `Handling Nested Timeouts`_
160-
- `Custom Timeout Exception`_
161-
- `Parameters`_
162-
- `Override Parameters`_
163-
- `Multithreading`_
164-
- `Subprocess Monitoring`_
165-
- `use as function not as decorator`_
166-
- `Dynamic Timeout Value Adjustment with eval`_
167-
- `Tools`_
168-
- `detect pickle errors`_
169-
- `set_subprocess_starting_method`_
170-
- `Logging Challenges with Subprocesses`_
171-
- `hard timeout`_
172-
- `Understanding Timeout Durations Across Platforms`_
173-
- `MYPY Testing`_
143+
- `Basic Usage`_
144+
- `General Recommendations`_
145+
- `use with Windows`_
146+
- `Quick Guide for the Eager`_
147+
- `In-Depth Explanation for the Curious`_
148+
- `Windows Compatibility Issue`_
149+
- `Timing Considerations`_
150+
- `Considerations using Signals`_
151+
- `Considerations using Subprocesses`_
152+
- `Overview`_
153+
- `Initialization`_
154+
- `Process Execution and Communication`_
155+
- `Subprocess Start Methods`_
156+
- `Choosing the Right Start Method`_
157+
- `Setting the Start Method`_
158+
- `Special Considerations for Uvicorn, FastAPI, asyncio`_
159+
- `Handling Nested Timeouts`_
160+
- `Custom Timeout Exception`_
161+
- `Parameters`_
162+
- `Override Parameters`_
163+
- `Multithreading`_
164+
- `Subprocess Monitoring`_
165+
- `use as function not as decorator`_
166+
- `Dynamic Timeout Value Adjustment with eval`_
167+
- `Tools`_
168+
- `detect pickle errors`_
169+
- `set_subprocess_starting_method`_
170+
- `Logging Challenges with Subprocesses`_
171+
- `hard timeout`_
172+
- `Understanding Timeout Durations Across Platforms`_
173+
- `MYPY Testing`_
174174

175175
Basic Usage
176176
-----------

0 commit comments

Comments
 (0)