Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions crates/revrt/src/ffi.rs
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,12 @@ fn _rust(py: Python<'_>, m: &Bound<'_, PyModule>) -> PyResult<()> {
/// should be a float that should be applied to scale the layer.
/// All of the layers in the list are processed this way and then
/// summed to obtain the final cost layer for routing.
/// start : list of (int, int)
/// start : list of tuple
/// List of two-tuples containing non-negative integers representing
/// the indices in the array for the pixel from which routing should
/// begin. A unique path will be returned for each of the starting
/// points.
/// end : list of (int, int)
/// end : list of tuple
/// List of two-tuples containing non-negative integers representing
/// the indices in the array for the any allowed final pixel.
/// When the algorithm reaches any of these points, the routing
Expand All @@ -65,7 +65,7 @@ fn _rust(py: Python<'_>, m: &Bound<'_, PyModule>) -> PyResult<()> {
///
/// Returns
/// -------
/// list of tuples
/// list of tuple
/// List of path routing results. Each result is a tuple
/// where the first element is a list of points that the
/// route goes through and the second element is the final
Expand Down
2 changes: 2 additions & 0 deletions docs/source/_templates/custom-module-template.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@

{% block modules %}
{% if modules %}
.. rubric:: {{ _('Modules') }}

.. autosummary::
:toctree:
:template: custom-module-template.rst
Expand Down
2 changes: 2 additions & 0 deletions revrt/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,7 @@

from ._rust import find_paths

# Needed for inclusion in Sphinx autodoc documentation generation
find_paths.__module__ = "revrt"

__version__ = version = importlib.metadata.version("NREL-reVRt")
Loading