Merge branch 'master' into develop

ntamas · ntamas · commit d052dc899323 · 2022-08-10T11:15:59.000+02:00
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -83,18 +83,21 @@ def get_igraph_version():
     #'sphinx_panels',
 ]
 
+# Using --no-sidebar option to skip the sidebar whole together not to generate noise in the HTML.
+# Because the pydoctor output is integrated in a smaller div with a custom CSS it's not optimal to include the sidebar.
 pydoctor_args = [
     '--project-name="igraph"',
     '--project-version=' + get_igraph_version(),
     '--project-url=https://igraph.org/python',
     '--introspect-c-modules',
+    '--no-sidebar',
     '--docformat=epytext',
     #'--intersphinx='+get_root_dir()+'/doc/tutorial/objects.inv',
     '--html-output=' + op.join(get_root_dir(), 'doc', 'html', 'api'),
     #'--html-viewsource-base=https://github.com/igraph/python-igraph/tree/default',
     '--project-base-dir=' + get_igraphdir(),
     get_igraphdir(),
-    ]
+]
 
 # API docs relative to the rest of the docs
 # NOTE: there is a bug in pydoctor that requires this to be a subfolder
diff --git a/scripts/mkdoc.sh b/scripts/mkdoc.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 #
-# Creates the API documentation for igraph's Python interface using PyDoctor
+# Creates the API documentation for igraph's Python interface
 #
 # Usage: ./mkdoc.sh (makes API and tutorial docs)
 #        ./mkdoc.sh -s (makes standalone docs that require no further processing)
diff --git a/src/igraph/structural.py b/src/igraph/structural.py
@@ -45,8 +45,6 @@ def _pagerank(
     weights=None,
     arpack_options=None,
     implementation="prpack",
-    niter=1000,
-    eps=0.001,
 ):
     """Calculates the PageRank values of a graph.
 
@@ -69,16 +67,8 @@ def _pagerank(
           implementation in igraph 0.7
         - C{"arpack"}: use the ARPACK library. This implementation
           was used from version 0.5, until version 0.7.
-        - C{"power"}: use a simple power method. This is the
-          implementation that was used before igraph version 0.5.
-    @param niter: The number of iterations to use in the power method
-      implementation. It is ignored in the other implementations
-    @param eps: The power method implementation will consider the
-      calculation as complete if the difference of PageRank values between
-      iterations change less than this value for every node. It is
-      ignored by the other implementations.
-    @return: a list with the Google PageRank values of the specified
-      vertices."""
+    @return: a list with the PageRank values of the specified vertices.
+    """
     if arpack_options is None:
         arpack_options = default_arpack_options
     return graph.personalized_pagerank(

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`#!/bin/bash`
`2`	`2`	`#`
`3`		`-# Creates the API documentation for igraph's Python interface using PyDoctor`
	`3`	`+# Creates the API documentation for igraph's Python interface`
`4`	`4`	`#`
`5`	`5`	`# Usage: ./mkdoc.sh (makes API and tutorial docs)`
`6`	`6`	`# ./mkdoc.sh -s (makes standalone docs that require no further processing)`