Skip to content

Commit

Permalink
Some doc fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
anntzer committed Jul 21, 2018
1 parent fc33dad commit b0c70be
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 9 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Linux

conda's compilers (``gxx_linux-64`` on the ``anaconda`` channel) `currently
interact poorly with installing cairo and pkg-config from conda-forge
<conda-build-2523>`_, so you are on your own to install a recent compiler
<conda-build-2523_>`_, so you are on your own to install a recent compiler
(e.g., using your distribution's package manager). You may want to set the
``CC`` and ``CXX`` environment variables to point to your C++ compiler if it is
nonstandard [#]_. In that case, be careful to set them to e.g. ``g++-7`` and
Expand Down Expand Up @@ -248,7 +248,7 @@ other hand, this is currently the only way in which the webagg-based backends
(e.g., Jupyter's inline widget) are supported.

At import-time, mplcairo will attempt to load Raqm_. The use of that library
can be controlled and checked using ``set_options`` and ``get_options``
can be controlled and checked using the ``set_options`` and ``get_options``
functions.

The examples_ directory contains a few cases where the output of this renderer
Expand Down
20 changes: 13 additions & 7 deletions src/_mplcairo.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1616,11 +1616,17 @@ PYBIND11_MODULE(_mplcairo, m)
throw std::runtime_error("Unknown options passed to set_options");
}
}, R"__doc__(
Set mplcairo options. The following options are available:
- cairo_circles (bool): Use cairo's circle drawing algorithm, rather than
Matplotlib's fixed spline approximation.
- marker_threads (int): Use this number of threads to render markers.
- raqm (bool): Use Raqm for text rendering.
Set mplcairo options.
Parameters
----------
cairo_circles : bool
Whether to use cairo's circle drawing algorithm, rather than Matplotlib's
fixed spline approximation.
marker_threads : int
Number of threads to use to render markers.
raqm : bool
Whether to use Raqm for text rendering.
)__doc__");
m.def(
"get_options", []() -> py::dict {
Expand All @@ -1629,8 +1635,8 @@ Set mplcairo options. The following options are available:
"marker_threads"_a=detail::MARKER_THREADS,
"raqm"_a=has_raqm());
}, R"__doc__(
Get current mplcairo options. See `set_mplcairo` for a description of
available options.
Get current mplcairo options. See `set_options` for a description of available
options.
)__doc__");

// Export classes.
Expand Down

0 comments on commit b0c70be

Please sign in to comment.