Skip to content

Commit 49253dd

Browse files
fgmacedoclaude
andcommitted
docs: use README.md as documentation landing page
Replace the bare toctree index with the full README content via {include}, giving the docs site a rich landing page with code examples (flat, guards, compound, parallel, history, eventless, error handling, async), feature highlights, and installation instructions. - Remove docs/readme.md (redundant wrapper) - Hide toctrees so sidebar stays clean - Remove "Indices and tables" section Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent ec722e1 commit 49253dd

2 files changed

Lines changed: 9 additions & 11 deletions

File tree

docs/index.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
1-
# Python State Machine
1+
```{include} ../README.md
2+
```
23

3-
Contents:
4+
---
45

56
```{toctree}
67
:caption: Getting started
78
:maxdepth: 2
9+
:hidden:
810
9-
readme
1011
installation
1112
tutorial
1213
```
1314

1415
```{toctree}
1516
:caption: Core Concepts
1617
:maxdepth: 2
18+
:hidden:
1719
1820
concepts
1921
statechart
@@ -28,6 +30,7 @@ listeners
2830
```{toctree}
2931
:caption: Engine
3032
:maxdepth: 2
33+
:hidden:
3134
3235
processing_model
3336
error_handling
@@ -39,6 +42,7 @@ behaviour
3942
```{toctree}
4043
:caption: Advanced
4144
:maxdepth: 2
45+
:hidden:
4246
4347
invoke
4448
models
@@ -50,6 +54,7 @@ weighted_transitions
5054
```{toctree}
5155
:caption: Reference
5256
:maxdepth: 2
57+
:hidden:
5358
5459
api
5560
auto_examples/index
@@ -60,14 +65,9 @@ authors
6065
```{toctree}
6166
:caption: Releases
6267
:maxdepth: 2
68+
:hidden:
6369
6470
releases/3.0.0
6571
releases/upgrade_2x_to_3
6672
releases/index
6773
```
68-
69-
## Indices and tables
70-
71-
* {ref}`genindex`
72-
* {ref}`modindex`
73-
* {ref}`search`

docs/readme.md

Lines changed: 0 additions & 2 deletions
This file was deleted.

0 commit comments

Comments
 (0)