mirror of
https://github.com/pybind/pybind11.git
synced 2024-11-22 13:15:12 +00:00
Fix sphinx doc missing code blocks and warnings
The missing empty line after `.. code-block::` resulted in incorrectly parsed restructuredtext (sphinx warnings) and the code blocks were not generated in the html output. The `exclude_patterns` change just silences the orphaned file warning. [ci skip]
This commit is contained in:
parent
94f2052d08
commit
aebca12bb9
@ -369,6 +369,7 @@ python classes. For example, suppose we extend the above ``Animal``/``Dog``
|
|||||||
example as follows:
|
example as follows:
|
||||||
|
|
||||||
.. code-block:: cpp
|
.. code-block:: cpp
|
||||||
|
|
||||||
class Animal {
|
class Animal {
|
||||||
public:
|
public:
|
||||||
virtual std::string go(int n_times) = 0;
|
virtual std::string go(int n_times) = 0;
|
||||||
@ -393,6 +394,7 @@ methods inherited from ``Animal`` (even though ``Dog`` doesn't directly
|
|||||||
override the ``name()`` method):
|
override the ``name()`` method):
|
||||||
|
|
||||||
.. code-block:: cpp
|
.. code-block:: cpp
|
||||||
|
|
||||||
class PyAnimal : public Animal {
|
class PyAnimal : public Animal {
|
||||||
public:
|
public:
|
||||||
using Animal::Animal; // Inherit constructors
|
using Animal::Animal; // Inherit constructors
|
||||||
@ -412,6 +414,7 @@ methods requires a similar trampoline class, *even if* it doesn't explicitly
|
|||||||
declare or override any virtual methods itself:
|
declare or override any virtual methods itself:
|
||||||
|
|
||||||
.. code-block:: cpp
|
.. code-block:: cpp
|
||||||
|
|
||||||
class Husky : public Dog {};
|
class Husky : public Dog {};
|
||||||
class PyHusky : public Husky {
|
class PyHusky : public Husky {
|
||||||
using Dog::Dog; // Inherit constructors
|
using Dog::Dog; // Inherit constructors
|
||||||
@ -426,6 +429,7 @@ methods). The technique involves using template trampoline classes, as
|
|||||||
follows:
|
follows:
|
||||||
|
|
||||||
.. code-block:: cpp
|
.. code-block:: cpp
|
||||||
|
|
||||||
template <class AnimalBase = Animal> class PyAnimal : public AnimalBase {
|
template <class AnimalBase = Animal> class PyAnimal : public AnimalBase {
|
||||||
using AnimalBase::AnimalBase; // Inherit constructors
|
using AnimalBase::AnimalBase; // Inherit constructors
|
||||||
std::string go(int n_times) override { PYBIND11_OVERLOAD_PURE(std::string, AnimalBase, go, n_times); }
|
std::string go(int n_times) override { PYBIND11_OVERLOAD_PURE(std::string, AnimalBase, go, n_times); }
|
||||||
@ -447,6 +451,7 @@ exposed, as above).
|
|||||||
The classes are then registered with pybind11 using:
|
The classes are then registered with pybind11 using:
|
||||||
|
|
||||||
.. code-block:: cpp
|
.. code-block:: cpp
|
||||||
|
|
||||||
py::class_<Animal, std::unique_ptr<Animal>, PyAnimal<>> animal(m, "Animal");
|
py::class_<Animal, std::unique_ptr<Animal>, PyAnimal<>> animal(m, "Animal");
|
||||||
py::class_<Dog, std::unique_ptr<Dog>, PyDog<>> dog(m, "Dog");
|
py::class_<Dog, std::unique_ptr<Dog>, PyDog<>> dog(m, "Dog");
|
||||||
py::class_<Husky, std::unique_ptr<Husky>, PyDog<Husky>> husky(m, "Husky");
|
py::class_<Husky, std::unique_ptr<Husky>, PyDog<Husky>> husky(m, "Husky");
|
||||||
@ -613,7 +618,7 @@ functions. The default policy is :enum:`return_value_policy::automatic`.
|
|||||||
| | side deletes an object that is still referenced and used by Python. |
|
| | side deletes an object that is still referenced and used by Python. |
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------+
|
||||||
| :enum:`return_value_policy::reference_internal` | Like :enum:`return_value_policy::reference` but additionally applies a |
|
| :enum:`return_value_policy::reference_internal` | Like :enum:`return_value_policy::reference` but additionally applies a |
|
||||||
| | :class:`keep_alive<0,1>()` call policy (described next) that keeps the |
|
| | ``keep_alive<0, 1>`` call policy (described next) that keeps the |
|
||||||
| | ``this`` argument of the function or property from being garbage collected |
|
| | ``this`` argument of the function or property from being garbage collected |
|
||||||
| | as long as the return value remains referenced. See the |
|
| | as long as the return value remains referenced. See the |
|
||||||
| | :class:`keep_alive` call policy (described next) for details. |
|
| | :class:`keep_alive` call policy (described next) for details. |
|
||||||
|
@ -75,7 +75,7 @@ language = None
|
|||||||
|
|
||||||
# List of patterns, relative to source directory, that match files and
|
# List of patterns, relative to source directory, that match files and
|
||||||
# directories to ignore when looking for source files.
|
# directories to ignore when looking for source files.
|
||||||
exclude_patterns = ['.build']
|
exclude_patterns = ['.build', 'release.rst']
|
||||||
|
|
||||||
# The reST default role (used for this markup: `text`) to use for all
|
# The reST default role (used for this markup: `text`) to use for all
|
||||||
# documents.
|
# documents.
|
||||||
|
Loading…
Reference in New Issue
Block a user