https://github.com/bhrutledge/sphinx-requests-typehints
https://github.com/bhrutledge/sphinx-requests-typehints
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/bhrutledge/sphinx-requests-typehints
- Owner: bhrutledge
- Created: 2021-09-17T10:52:54.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-01-22T18:52:51.000Z (over 4 years ago)
- Last Synced: 2024-04-14T23:27:31.290Z (over 2 years ago)
- Language: Python
- Homepage:
- Size: 13.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sphinx-requests-typehints
Example project showing how Sphinx's [`autdoc`](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html) and [`intersphinx`](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html) extensions handle type hints from [`requests`](https://docs.python-requests.org/en/master/).
See the rendered API documentation at .
## Getting started
In an active virtual environment:
```sh
pip install -r requirements.txt
make -C docs html
open docs/_build/html/example_package.html
```
To run a live server:
```sh
make -C docs livehtml
```