Skip to content

Commit 5e4078e

Browse files
authored
Modify README.rst to pass validation (#441)
* Modify README.rst to pass validation * Add readme_renderer test
1 parent 1a4f0bf commit 5e4078e

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

.github/workflows/auto-testing.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,7 @@ jobs:
2727
- name: Test with pytest
2828
run: |
2929
tox
30+
- name: Ensure README.rst builds correctly for PyPI
31+
run: |
32+
pip install readme-renderer
33+
python -m readme_renderer README.rst >/dev/null

README.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ Examples
236236
Sample echo-bot with asynchronous processings.
237237
238238
`fastapi-echo <examples/fastapi-echo>`__
239-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
239+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
240240
241241
Sample echo-bot using `FastAPI <https://fastapi.tiangolo.com/>`__
242242
@@ -323,6 +323,13 @@ You can generate new or fixed models and APIs by this command.
323323
When you update line-bot-sdk-python version, please update `linebot/__about__.py <linebot/__about__.py>`__ and generate code again.
324324
325325
326+
If you edit `README.rst <README.rst>`__, you should execute the following command to check the syntax of README.
327+
328+
::
329+
330+
$ python -m readme_renderer README.rst
331+
332+
326333
Run tests
327334
~~~~~~~~~
328335

0 commit comments

Comments
 (0)