Skip to content

Commit 7ac4cc9

Browse files
committed
Add post-processing to docs
1 parent 250fda0 commit 7ac4cc9

File tree

3 files changed

+9
-10
lines changed

3 files changed

+9
-10
lines changed

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@
33
To update the `docs.md` file, run:
44

55
```shell
6-
$ uv run pydoc-markdown
6+
$ uv run pydoc-markdown | sed 's/####/###/g' > docs.md
77
```

docs/docs.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ def read_root() -> dict[str, str]: ...
5252

5353
<a id="rest_rpc.api_definition.ApiDefinition.route"></a>
5454

55-
#### route
55+
### route
5656

5757
```python
5858
def route(method: str, path: str)
@@ -88,7 +88,7 @@ def read_item(item_id: int) -> dict[str, Any]: ...
8888

8989
<a id="rest_rpc.api_definition.ApiDefinition.delete"></a>
9090

91-
#### delete
91+
### delete
9292

9393
```python
9494
def delete(path: str)
@@ -106,7 +106,7 @@ def route() -> dict[str,Any]: ...
106106

107107
<a id="rest_rpc.api_definition.ApiDefinition.get"></a>
108108

109-
#### get
109+
### get
110110

111111
```python
112112
def get(path: str)
@@ -124,7 +124,7 @@ def route() -> dict[str,Any]: ...
124124

125125
<a id="rest_rpc.api_definition.ApiDefinition.patch"></a>
126126

127-
#### patch
127+
### patch
128128

129129
```python
130130
def patch(path: str)
@@ -142,7 +142,7 @@ def route() -> dict[str,Any]: ...
142142

143143
<a id="rest_rpc.api_definition.ApiDefinition.post"></a>
144144

145-
#### post
145+
### post
146146

147147
```python
148148
def post(path: str)
@@ -160,7 +160,7 @@ def route() -> dict[str,Any]: ...
160160

161161
<a id="rest_rpc.api_definition.ApiDefinition.put"></a>
162162

163-
#### put
163+
### put
164164

165165
```python
166166
def put(path: str)
@@ -327,7 +327,7 @@ def read_root():
327327

328328
<a id="rest_rpc.api_implementation.ApiImplementation.handler"></a>
329329

330-
#### handler
330+
### handler
331331

332332
```python
333333
def handler(func)
@@ -354,7 +354,7 @@ def read_root():
354354

355355
<a id="rest_rpc.api_implementation.ApiImplementation.make_fastapi"></a>
356356

357-
#### make\_fastapi
357+
### make\_fastapi
358358

359359
```python
360360
def make_fastapi()

docs/pydoc-markdown.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,3 @@ processors:
1717

1818
renderer:
1919
type: markdown
20-
filename: docs.md

0 commit comments

Comments
 (0)