Skip to content

Commit 0842ceb

Browse files
committed
docs: restructure and expand documentation
Documentation restructure: - Reorganized into topic-based sections: getting-started/, guide/, examples/, api/, migration/ - Added installation guide with Qt SVG dependency note - Added quickstart tutorial with step-by-step screenshots - Expanded data-flow guide with validation and processing status - Added FAQ and v2-to-v3 migration guide Screenshots and diagrams: - Added 19 screenshots in docs/_static/screenshots/ - Added PlantUML architecture diagrams in docs/_static/diagrams/ - Moved README showcase images to assets/ - Increased image sizes for better visibility Build configuration: - Fixed Sphinx SOURCEDIR path - Added venv to exclude_patterns
1 parent fdaf948 commit 0842ceb

54 files changed

Lines changed: 3534 additions & 629 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Warning
3434
Branches
3535
--------
3636

37-
There are branchses ``v2`` and ``v3`` for versions ``2.x.x`` and ``3.x``
37+
There are branches ``v2`` and ``v3`` for versions ``2.x.x`` and ``3.x``
3838
respectively. The branch ``master`` contains the latest dev state.
3939

4040

@@ -74,7 +74,7 @@ Dependencies
7474
------------
7575

7676
* Qt >5.15
77-
* CMake 3.8
77+
* CMake 3.11
7878
* Catch2
7979

8080

@@ -118,7 +118,7 @@ For building a static lib use:
118118

119119
::
120120

121-
cmake .. -BUILD_SHARED_LIBS=off
121+
cmake .. -DBUILD_SHARED_LIBS=off
122122

123123
Linux
124124
-----
@@ -193,9 +193,9 @@ For detailed testing documentation, see the `Testing Guide <https://qtnodes.read
193193
Help Needed
194194
===========
195195

196-
#. Python wrappring using PySide.
196+
#. Python wrapping using PySide.
197197
#. QML frontend.
198-
#. Wirting a ClangFormat config.
198+
#. Writing a ClangFormat config.
199199

200200
Any suggestions are welcome!
201201

@@ -220,7 +220,7 @@ Contribution
220220
#. Describe your issue in details
221221
#. Provide some use cases.
222222

223-
#. I maintain this probject in my free time, when I am not busy with my work or
223+
#. I maintain this project in my free time, when I am not busy with my work or
224224
my family. **If I do not react or do not answer for too long, please ping
225225
me**.
226226

@@ -288,7 +288,7 @@ every automotive developer. Thanks to modularity it is easy to implement new,
288288
custom features.
289289

290290

291-
.. image:: docs/_static/showcase_CANdevStudio.png
291+
.. image:: assets/showcase-candevstudio.png
292292

293293

294294
Chigraph
@@ -297,7 +297,7 @@ Chigraph
297297
`Chigraph <https://github.com/chigraph/chigraph>`_ is a visual programming
298298
language for beginners that is unique in that it is an intuitive flow graph:
299299

300-
.. image:: docs/_static/chigraph.png
300+
.. image:: assets/chigraph.png
301301

302302

303303
It features easy bindings to C/C++, package management, and a cool interface.
@@ -310,4 +310,4 @@ Spkgen particle editor
310310
particles engine that uses a node-based interface to create particles effects for
311311
games
312312

313-
.. image:: docs/_static/spkgen.png
313+
.. image:: assets/spkgen.png
File renamed without changes.

docs/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
# from the environment for the first two.
66
SPHINXOPTS ?=
77
SPHINXBUILD ?= sphinx-build
8-
SOURCEDIR = source
8+
SOURCEDIR = .
99
BUILDDIR = build
1010

1111
# Put it first so that "make" without argument is like "make help".
17.7 KB
Loading
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
@startuml architecture-diagram
2+
!theme plain
3+
skinparam backgroundColor #2B2B2B
4+
skinparam defaultFontColor #E0E0E0
5+
skinparam classBorderColor #606060
6+
skinparam classBackgroundColor #3C3F41
7+
skinparam arrowColor #A0A0A0
8+
skinparam noteBorderColor #606060
9+
skinparam noteBackgroundColor #4A4D4F
10+
11+
skinparam rectangle {
12+
BackgroundColor #3C3F41
13+
BorderColor #606060
14+
FontColor #E0E0E0
15+
}
16+
17+
rectangle "Your Application" as app #4A5568 {
18+
rectangle "Your Data\n(nodes, connections,\npositions, values)" as data #718096
19+
}
20+
21+
rectangle "QtNodes Library" as lib #2D3748 {
22+
rectangle "AbstractGraphModel\n(or DataFlowGraphModel)" as model #4A5568
23+
rectangle "BasicGraphicsScene\n(or DataFlowGraphicsScene)" as scene #4A5568
24+
rectangle "GraphicsView" as view #4A5568
25+
}
26+
27+
rectangle "User Interface" as ui #1A202C {
28+
rectangle "Window with\ninteractive nodes" as window #2D3748
29+
}
30+
31+
data -right-> model : "implements"
32+
model -right-> scene : "visualizes"
33+
scene -right-> view : "displays in"
34+
view -right-> window : "renders to"
35+
36+
note bottom of model
37+
You subclass this
38+
to store your graph data
39+
end note
40+
41+
note bottom of scene
42+
Automatically creates
43+
graphics objects from
44+
model data
45+
end note
46+
47+
note bottom of view
48+
Handles zoom, pan,
49+
selection, and
50+
user interactions
51+
end note
52+
53+
@enduml
12.2 KB
Loading
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
@startuml dataflow-diagram
2+
!theme plain
3+
skinparam backgroundColor #2B2B2B
4+
skinparam defaultFontColor #E0E0E0
5+
skinparam componentBorderColor #606060
6+
skinparam componentBackgroundColor #3C3F41
7+
skinparam arrowColor #4299E1
8+
skinparam noteBorderColor #606060
9+
skinparam noteBackgroundColor #4A4D4F
10+
11+
skinparam rectangle {
12+
BackgroundColor #3C3F41
13+
BorderColor #606060
14+
FontColor #E0E0E0
15+
RoundCorner 15
16+
}
17+
18+
rectangle "Source Node\n(NumberSourceDataModel)" as source #48BB78 {
19+
}
20+
21+
rectangle "Operator Node\n(AdditionModel)" as operator #4299E1 {
22+
}
23+
24+
rectangle "Display Node\n(NumberDisplayDataModel)" as display #ED8936 {
25+
}
26+
27+
source -right-> operator : "outData()"
28+
operator -right-> display : "outData()"
29+
30+
note bottom of source
31+
**Emits data**
32+
Creates values
33+
(e.g., number input)
34+
end note
35+
36+
note bottom of operator
37+
**Processes data**
38+
Receives via setInData()
39+
Outputs via outData()
40+
end note
41+
42+
note bottom of display
43+
**Consumes data**
44+
Receives and shows
45+
the final result
46+
end note
47+
48+
@enduml

0 commit comments

Comments
 (0)