Skip to content

Commit 77d8189

Browse files
committed
Fix all the remaining broken links and redirects
Fix typos and grammar
1 parent ef38ec8 commit 77d8189

1 file changed

Lines changed: 17 additions & 14 deletions

File tree

README.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
<img alt="GitHub Actions" src="https://github.com/collective/sphinxcontrib-httpexample/actions/workflows/build.yml/badge.svg?branch=master" href="https://github.com/collective/sphinxcontrib-httpexample/actions">
44
<img alt="Coverage" src="https://coveralls.io/repos/github/collective/sphinxcontrib-httpexample/badge.svg?branch=master" href="https://coveralls.io/github/collective/sphinxcontrib-httpexample?branch=master">
5-
<img alt="PyPI package" src="https://badge.fury.io/py/sphinxcontrib-httpexample.svg" href="https://badge.fury.io/py/sphinxcontrib-httpexample">
6-
<img alt="Documentation" src="https://readthedocs.org/projects/sphinxcontrib-httpexample/badge/?version=latest" href="http://sphinxcontrib-httpexample.readthedocs.io/en/latest">
5+
<img alt="PyPI package" src="https://badge.fury.io/py/sphinxcontrib-httpexample.svg" href="https://pypi.org/project/sphinxcontrib-httpexample/">
6+
<img alt="Documentation" src="https://readthedocs.org/projects/sphinxcontrib-httpexample/badge/?version=latest" href="https://sphinxcontrib-httpexample.readthedocs.io/en/latest/">
77

88
sphinxcontrib-httpexample enhances [`sphinxcontrib-httpdomain`](https://github.com/sphinx-contrib/httpdomain), a Sphinx domain extension for describing RESTful HTTP APIs in detail, with a simple call example directive. The new directive provided by this extension generates RESTful HTTP API call examples for different tools from a single HTTP request example.
99

@@ -12,32 +12,33 @@ The audience for this extension are developers and technical writes documenting
1212

1313
## Features
1414

15-
- Directive for generating various RESTful HTTP API call examples from single HTTP request.
15+
- Directive for generating various RESTful HTTP API call examples from a single HTTP request.
1616
- Supported tools:
1717

18-
- [curl](https://curl.haxx.se/)
18+
- [curl](https://curl.se/)
1919
- [wget](https://www.gnu.org/software/wget/)
20-
- [httpie](https://httpie.org/)
21-
- [python-requests](http://docs.python-requests.org/)
20+
- [httpie](https://httpie.io/)
21+
- [python-requests](https://requests.readthedocs.io/en/latest/)
2222

2323

2424
## Examples
2525

26-
This extension has been used at least in the following documentations:
26+
This extension has been used in documentation for the following projects and probably other similar projects as well.
2727

2828
- https://6.docs.plone.org/plone.restapi/docs/source/index.html
29-
- https://sphinxcontrib-httpexample.readthedocs.org/en/latest/
29+
- https://sphinxcontrib-httpexample.readthedocs.io/en/latest/
3030
- https://guillotina.readthedocs.io/en/latest/
3131

3232

3333
## Documentation
3434

35-
Full documentation for end users can be found in the "docs" folder. It is also available online at http://sphinxcontrib-httpexample.readthedocs.org/
35+
Full documentation for end users can be found in the `docs` folder.
36+
It's also available online at https://sphinxcontrib-httpexample.readthedocs.io/en/latest/.
3637

3738

3839
## Installation
3940

40-
Add `sphinxcontrib-httpexample` and `sphincontrib-httpdomain` into your project requirements.
41+
Add `sphinxcontrib-httpexample` and `sphincontrib-httpdomain` to your project requirements.
4142

4243
Then configure your Sphinx configuration file `conf.py` with `sphinxcontrib.httpdomain` and `sphinxcontrib.httpexample` as follows.
4344

@@ -56,8 +57,8 @@ To contribute to `sphinxcontrib-httpexample`, first set up your environment.
5657

5758
### Set up development environment
5859

59-
Install [uv](https://6.docs.plone.org/glossary.html#term-uv).
60-
Carefully read the console output for further instructions, and follow them, if needed.
60+
Install [uv](https://docs.astral.sh/uv/getting-started/installation/).
61+
Carefully read the console output for further instruction.
6162

6263
```shell
6364
curl -LsSf https://astral.sh/uv/install.sh | sh
@@ -75,9 +76,10 @@ Install `sphinxcontrib-httpexample`.
7576
uv sync
7677
```
7778

79+
7880
### Build documentation
7981

80-
Rebuild Sphinx documentation on changes, with live-reload in the browser
82+
Rebuild Sphinx documentation on changes, with live reload in the browser.
8183

8284
```shell
8385
make livehtml
@@ -88,7 +90,8 @@ To stop the preview, type `CTRL-C`.
8890

8991
### Run tests
9092

91-
make te
93+
make test
94+
9295

9396
## License
9497

0 commit comments

Comments
 (0)