Skip to content

Commit

Permalink
badges, enable PDF documentation build
Browse files Browse the repository at this point in the history
  • Loading branch information
wjakob committed Feb 23, 2023
1 parent 5648b6c commit 32e860a
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 8 deletions.
5 changes: 5 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ version: 2

build:
os: ubuntu-22.04
apt_packages:
- librsvg2-bin
tools:
python: "3.11"

Expand All @@ -11,3 +13,6 @@ sphinx:
python:
install:
- requirements: docs/requirements.txt

formats:
- pdf
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# nanobind — Seamless operability between C++17 and Python

[![Documentation](https://readthedocs.org/projects/nanobind/badge/?version=latest)](https://nanobind.readthedocs.io/en/latest/)
[![Continuous Integration](https://img.shields.io/github/actions/workflow/status/wjakob/nanobind/ci.yml?label=checks)](https://github.com/wjakob/nanobind/actions/workflows/ci.yml)
[![](https://img.shields.io/pypi/v/nanobind.svg?color=green)](https://pypi.org/pypi/nanobind/)
![](https://img.shields.io/pypi/l/nanobind.svg)
[![](https://img.shields.io/badge/Example-Link-green)](https://github.com/wjakob/nanobind_example)
[![](https://img.shields.io/badge/Changelog-Link-green)](https://nanobind.readthedocs.io/en/latest/changelog.html)
[![Documentation](https://img.shields.io/readthedocs/nanobind/latest)](https://nanobind.readthedocs.io/en/latest/)
[![Continuous Integration](https://img.shields.io/github/actions/workflow/status/wjakob/nanobind/ci.yml?label=tests)](https://github.com/wjakob/nanobind/actions/workflows/ci.yml)
[![](https://img.shields.io/pypi/v/nanobind.svg?color=brightgreen)](https://pypi.org/pypi/nanobind/)
![](https://img.shields.io/pypi/l/nanobind.svg?color=brightgreen)
[![](https://img.shields.io/badge/Example-Link-brightgreen)](https://github.com/wjakob/nanobind_example)
[![](https://img.shields.io/badge/Changelog-Link-brightgreen)](https://nanobind.readthedocs.io/en/latest/changelog.html)

_nanobind_ is a small binding library that exposes C++ types in Python and vice
versa. It is reminiscent of
Expand All @@ -22,5 +22,6 @@ lower** runtime overheads compared to pybind11.

## Documentation

nanobind's [readthedocs page](https://nanobind.readthedocs.io/en/latest/)
provides tutorials and detailed reference documentation.
Please see the following links for tutorial and reference documentation in
[HTML](https://nanobind.readthedocs.io/en/latest/) and
[PDF](https://nanobind.readthedocs.io/_/downloads/en/latest/pdf/) formats.

0 comments on commit 32e860a

Please sign in to comment.