doc: moar docs!

Author: ntamas

docs/api/constructors.md

@@ -0,0 +1,5 @@
+# Graph constructors
+
+## `igraph_ctypes.constructors` module
+
+::: igraph_ctypes.constructors

docs/reference.md docs/api/graph.mddocs/reference.md renamed to docs/api/graph.md

@@ -1,3 +1,3 @@
-# Reference
+# The Graph class
 
 ::: igraph_ctypes.Graph

docs/api/paths.md

@@ -0,0 +1,5 @@
+# Shortest paths and components
+
+## `igraph_ctypes.paths` module
+
+::: igraph_ctypes.paths

mkdocs.yml

@@ -1,17 +1,23 @@
 site_name: igraph ctypes interface for Python
 repo_url: https://github.com/igraph/python-igraph-ctypes
-# repo_name: igraph/python-igraph-ctypes
 
 nav:
   - Home: index.md
   - Notes: notes.md
-  - API reference: reference.md
+  - API reference:
+      - api/graph.md
+      - api/constructors.md
+      - api/paths.md
+
+exclude_docs: |
+  fragments/
 
 theme:
   name: material
 
   features:
     - content.action.edit
+    - content.code.copy
     - navigation.instant
     - navigation.tracking
     - navigation.footer
@@ -63,4 +69,3 @@ plugins:
             - src
           options:
             show_source: false
-

src/igraph_ctypes/paths.py

@@ -16,7 +16,14 @@
 __all__ = ("components", "shortest_path")
 
 
-def components(graph: Graph, mode: Connectedness = Connectedness.WEAK):
+def components(graph: Graph, mode: Connectedness = Connectedness.WEAK) -> IntArray:
+    """Finds the weakly or strongly connected components of a graph.
+
+    Args:
+        graph: the graph
+        mode: whether the function should return weakly or strongly connected
+            components
+    """
     membership, _, _ = connected_components(graph, mode)
     return membership
 
@@ -29,6 +36,22 @@ def shortest_path(
     weights: Optional[Iterable[float]] = None,
     method: str = "dijkstra",
 ) -> IntArray:
+    """Finds a single shortest path between two vertices in a graph.
+
+    Args:
+        graph: the graph
+        source: the source vertex
+        target: the target vertex
+        mode: TODO
+        weights: list of weights for each edge in the graph, or ``None`` to treat
+            the edges as unweighted
+        method: the method to use for finding shortest paths when the graph is
+            weighted. May be one of `"dijkstra"` (Dijkstra's algorithm) or
+            `"bellman-ford"` (Bellman-Ford algorithm).
+
+    Returns:
+        the IDs of the vertices along the shortest path
+    """
     # TODO(ntamas): handle epath?
     if weights is None:
         vpath, _ = get_shortest_path(graph, source, target, mode)