Skip to content

Commit 3a4e89d

Browse files
committed
docs: update API reference links in documentation
1 parent 8216c76 commit 3a4e89d

File tree

4 files changed

+22
-18
lines changed

4 files changed

+22
-18
lines changed

docs/examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ Support multiple configuration sources with priority-based fallback.
273273

274274
- **[Getting Started](getting-started.md)** - Basic concepts
275275
- **[Guides](guide/defining-hooks.md)** - Feature-specific documentation
276-
- **[API Reference](api/index.md)** - Complete API documentation
276+
- **[API Reference](api/simplug.md)** - Complete API documentation
277277
- **[Source Code](https://github.com/pwwang/simplug)** - Browse implementation
278278

279279
## Creating Your Own Examples

docs/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,4 +144,4 @@ print(enriched) # [{'title': 'Write documentation', 'priority': 'medium'}, {'ti
144144
- **[Defining Hooks](guide/defining-hooks.md)** - Learn about hook options and specifications
145145
- **[Implementing Hooks](guide/implementing-hooks.md)** - Deep dive into plugin implementation
146146
- **[Result Collection](guide/result-collection.md)** - Explore the 18 result strategies
147-
- **[API Reference](api/index.md)** - Complete API documentation
147+
- **[API Reference](api/simplug.md)** - Complete API documentation

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ simplug is ideal for:
7777

7878
- **[Getting Started](getting-started.md)** - Learn the basics
7979
- **[Guides](guide/defining-hooks.md)** - Detailed documentation on specific features
80-
- **[API Reference](api/index.md)** - Complete API documentation
80+
- **[API Reference](api/simplug.md)** - Complete API documentation
8181
- **[Examples](examples.md)** - Code examples and patterns
8282

8383
## License

mkdocs.yml

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,10 @@
11
site_name: simplug
22
site_description: A simple plugin system for Python with async hooks supported
33
site_author: pwwang
4-
site_url: https://pwwang.github.io/simplug/
4+
# site_url: https://pwwang.github.io/simplug/
55
repo_url: https://github.com/pwwang/simplug
66
repo_name: pwwang/simplug
77

8-
nav:
9-
- Home: index.md
10-
- Getting Started: getting-started.md
11-
- Guides:
12-
- Defining Hooks: guide/defining-hooks.md
13-
- Implementing Hooks: guide/implementing-hooks.md
14-
- Result Collection: guide/result-collection.md
15-
- Plugin Registry: guide/plugin-registry.md
16-
- Priority System: guide/priority-system.md
17-
- Async Hooks: guide/async-hooks.md
18-
- Setuptools Entrypoints: guide/entrypoints.md
19-
- API Reference: mkapi/api/simplug
20-
- Examples: examples.md
21-
228
theme:
239
name: material
2410
palette:
@@ -66,8 +52,26 @@ markdown_extensions:
6652
- toc:
6753
permalink: true
6854

55+
extra_css:
56+
- style.css
57+
6958
extra:
7059
social:
7160
- icon: fontawesome/brands/github
7261
link: https://github.com/pwwang/simplug
7362
name: GitHub
63+
64+
nav:
65+
- '': mkapi/api/simplug
66+
- Home: index.md
67+
- Getting Started: getting-started.md
68+
- Guides:
69+
- Defining Hooks: guide/defining-hooks.md
70+
- Implementing Hooks: guide/implementing-hooks.md
71+
- Result Collection: guide/result-collection.md
72+
- Plugin Registry: guide/plugin-registry.md
73+
- Priority System: guide/priority-system.md
74+
- Async Hooks: guide/async-hooks.md
75+
- Setuptools Entrypoints: guide/entrypoints.md
76+
- API Reference: api/simplug.md
77+
- Examples: examples.md

0 commit comments

Comments
 (0)