Skip to content

Commit

Permalink
[centrality] added metrics-family to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bedupako12mas committed Aug 12, 2024
1 parent 0f9b962 commit 3d79833
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 2 deletions.
5 changes: 3 additions & 2 deletions doc/metrics/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@

SET(LOCAL_FILES
pgr_betweennessCentrality.rst
)
metrics-family.rst
pgr_betweennessCentrality.rst
)

foreach (f ${LOCAL_FILES})
configure_file(${f} "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}")
Expand Down
41 changes: 41 additions & 0 deletions doc/metrics/metrics-family.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
..
****************************************************************************
pgRouting Manual
Copyright(c) pgRouting Contributors
This documentation is licensed under a Creative Commons Attribution-Share
Alike 3.0 License: https://creativecommons.org/licenses/by-sa/3.0/
****************************************************************************

|


Metrics - Family of functions
===============================================================================

.. rubric:: Experimental

.. include:: experimental.rst
:start-after: begin-warn-expr
:end-before: end-warn-expr

.. index experimental from here
* :doc:`pgr_betweennessCentrality` - Calculates relative betweenness centrality using Brandes Algorithm

.. index experimental to here
.. toctree::
:hidden:

pgr_betweennessCentrality

See Also
-------------------------------------------------------------------------------

.. rubric:: Indices and tables

* :ref:`genindex`
* :ref:`search`
6 changes: 6 additions & 0 deletions doc/src/experimental.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,12 @@ Experimental Functions
:start-after: index from here
:end-before: index to here

:doc:`metrics-family`

.. include:: metrics-family.rst
:start-after: index experimental from here
:end-before: index experimental to here

:doc:`TRSP-family`

.. include:: TRSP-family.rst
Expand Down

0 comments on commit 3d79833

Please sign in to comment.