Skip to content

Commit 3d79833

Browse files
committed
[centrality] added metrics-family to docs
1 parent 0f9b962 commit 3d79833

File tree

3 files changed

+50
-2
lines changed

3 files changed

+50
-2
lines changed

doc/metrics/CMakeLists.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11

22
SET(LOCAL_FILES
3-
pgr_betweennessCentrality.rst
4-
)
3+
metrics-family.rst
4+
pgr_betweennessCentrality.rst
5+
)
56

67
foreach (f ${LOCAL_FILES})
78
configure_file(${f} "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}")

doc/metrics/metrics-family.rst

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
..
2+
****************************************************************************
3+
pgRouting Manual
4+
Copyright(c) pgRouting Contributors
5+
6+
This documentation is licensed under a Creative Commons Attribution-Share
7+
Alike 3.0 License: https://creativecommons.org/licenses/by-sa/3.0/
8+
****************************************************************************
9+
10+
|
11+
12+
13+
14+
Metrics - Family of functions
15+
===============================================================================
16+
17+
.. rubric:: Experimental
18+
19+
.. include:: experimental.rst
20+
:start-after: begin-warn-expr
21+
:end-before: end-warn-expr
22+
23+
.. index experimental from here
24+
25+
* :doc:`pgr_betweennessCentrality` - Calculates relative betweenness centrality using Brandes Algorithm
26+
27+
.. index experimental to here
28+
29+
30+
.. toctree::
31+
:hidden:
32+
33+
pgr_betweennessCentrality
34+
35+
See Also
36+
-------------------------------------------------------------------------------
37+
38+
.. rubric:: Indices and tables
39+
40+
* :ref:`genindex`
41+
* :ref:`search`

doc/src/experimental.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,12 @@ Experimental Functions
8383
:start-after: index from here
8484
:end-before: index to here
8585

86+
:doc:`metrics-family`
87+
88+
.. include:: metrics-family.rst
89+
:start-after: index experimental from here
90+
:end-before: index experimental to here
91+
8692
:doc:`TRSP-family`
8793

8894
.. include:: TRSP-family.rst

0 commit comments

Comments
 (0)