Skip to content

Commit b59f0e9

Browse files
lums658claude
andcommitted
Fix documentation structure duplication
- Remove duplicate "Examples" heading from examples/index.rst - Remove redundant example descriptions (already in bglbook/index.rst) - Rename "Reference Manual" to "API Reference" in main index - Rename "NWGraph API Reference" to "Core API" to avoid redundancy Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 5575394 commit b59f0e9

File tree

3 files changed

+6
-43
lines changed

3 files changed

+6
-43
lines changed

doc-src/sphinx/examples/index.rst

Lines changed: 1 addition & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -3,46 +3,12 @@
33
..
44
.. SPDX-License-Identifier: BSD-3-Clause
55
6-
========
7-
Examples
8-
========
9-
106
This section presents examples demonstrating how to use NWGraph for various
11-
graph algorithms and applications. The examples are organized to help you
12-
understand both the library's capabilities and the underlying algorithms.
7+
graph algorithms and applications.
138

149
.. toctree::
1510
:maxdepth: 2
16-
:caption: Example Categories
1711

1812
bglbook/index
1913
degrees/index
2014
imdb/index
21-
22-
BGL Book Examples
23-
-----------------
24-
25-
Examples adapted from "The Boost Graph Library" book by Jeremy G. Siek,
26-
Lie-Quan Lee, and Andrew Lumsdaine (Addison-Wesley, 2002). These demonstrate
27-
how NWGraph provides similar functionality using modern C++20 idioms.
28-
29-
- **Chapter 3**: Topological Sort - File dependencies
30-
- **Chapter 4**: BFS and DFS - Kevin Bacon numbers, loop detection
31-
- **Chapter 5**: Shortest Paths - Dijkstra and Bellman-Ford
32-
- **Chapter 6**: Minimum Spanning Trees - Kruskal and Prim
33-
- **Chapter 7**: Connected Components - BFS-based and Tarjan's SCC
34-
- **Chapter 8**: Maximum Flow - Edmonds-Karp algorithm
35-
- **Chapter 9**: Implicit Graphs - Knight's Tour
36-
37-
Six Degrees of Separation
38-
-------------------------
39-
40-
A detailed walkthrough showing how to compute "Bacon numbers" using NWGraph,
41-
demonstrating the "there is no graph" design philosophy by starting from
42-
raw database records and building graph structures on-the-fly.
43-
44-
IMDB Examples
45-
-------------
46-
47-
Real-world examples using Internet Movie Database data to demonstrate
48-
graph analysis at scale, including the Oracle of Bacon implementation.

doc-src/sphinx/index.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,17 +55,14 @@ Examples
5555

5656

5757

58-
================
59-
Reference Manual
60-
================
58+
=============
59+
API Reference
60+
=============
6161

6262
.. toctree::
6363
:maxdepth: 2
6464

6565
nwgraph_api.rst
66-
67-
68-
6966
api/library_root
7067
.. doxyref/index.rst
7168

doc-src/sphinx/nwgraph_api.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
..
44
.. SPDX-License-Identifier: BSD-3-Clause
55
6-
NWGraph API Reference
7-
=====================
6+
Core API
7+
========
88

99
.. highlight:: c++
1010

0 commit comments

Comments
 (0)