mirror of
https://github.com/pybind/pybind11.git
synced 2024-11-29 08:32:02 +00:00
updated pbtest link
This commit is contained in:
parent
aa79af09f6
commit
ca8dc08a66
@ -1533,7 +1533,7 @@ Generating documentation using Sphinx
|
|||||||
|
|
||||||
Sphinx [#f4]_ has the ability to inspect the signatures and documentation
|
Sphinx [#f4]_ has the ability to inspect the signatures and documentation
|
||||||
strings in pybind11-based extension modules to automatically generate beautiful
|
strings in pybind11-based extension modules to automatically generate beautiful
|
||||||
documentation in a variety formats. The pbtest repository [#f5]_ contains a
|
documentation in a variety formats. The python_example repository [#f5]_ contains a
|
||||||
simple example repository which uses this approach.
|
simple example repository which uses this approach.
|
||||||
|
|
||||||
There are two potential gotchas when using this approach: first, make sure that
|
There are two potential gotchas when using this approach: first, make sure that
|
||||||
@ -1561,4 +1561,4 @@ work, it is important that all lines are indented consistently, i.e.:
|
|||||||
)mydelimiter");
|
)mydelimiter");
|
||||||
|
|
||||||
.. [#f4] http://www.sphinx-doc.org
|
.. [#f4] http://www.sphinx-doc.org
|
||||||
.. [#f5] http://github.com/pybind/pbtest
|
.. [#f5] http://github.com/pybind/python_example
|
||||||
|
@ -7,9 +7,9 @@ Building with setuptools
|
|||||||
For projects on PyPI, building with setuptools is the way to go. Sylvain Corlay
|
For projects on PyPI, building with setuptools is the way to go. Sylvain Corlay
|
||||||
has kindly provided an example project which shows how to set up everything,
|
has kindly provided an example project which shows how to set up everything,
|
||||||
including automatic generation of documentation using Sphinx. Please refer to
|
including automatic generation of documentation using Sphinx. Please refer to
|
||||||
the [pbtest]_ repository.
|
the [python_example]_ repository.
|
||||||
|
|
||||||
.. [pbtest] https://github.com/pybind/pbtest
|
.. [python_example] https://github.com/pybind/python_example
|
||||||
|
|
||||||
Building with cppimport
|
Building with cppimport
|
||||||
========================
|
========================
|
||||||
|
Loading…
Reference in New Issue
Block a user