Doc structure updated: examples moved in a separate section

This commit is contained in:
Nicolas 2026-08-06 11:44:34 +02:00
parent 70b916cc34
commit c744e380af
4 changed files with 13 additions and 5 deletions

View File

@ -9,4 +9,4 @@ example_asm
```{include} ../build/compiler.md
```
A full listing of all stencils with machine code for all architectures from latest build is here available: [Stencil overview](stencil_doc.md). The compiler output for a full example program from latest compiler build is here available: [Example program](example_asm).
A full listing of all stencils with machine code for all architectures from latest build is here available: [Stencil overview](stencil_doc.md). The compiler output for a full example program from latest compiler build is here available: [Example program](example_asm).

4
docs/source/examples.md Normal file
View File

@ -0,0 +1,4 @@
# Examples
```{include} ../build/examples.md
```

View File

@ -62,9 +62,12 @@ if __name__ == '__main__':
readme = extract_sections(f.read())
with open(os.path.join(build_dir, 'start.md'), 'wt') as f:
f.write('\n'.join('\n'.join(readme[s]) if s != 'Copapy' else readme[s][1] for s in [
'Copapy', 'Current state', 'Install', 'Examples',
'Basic example', 'Inverse kinematics', 'License']))
f.write('# Introduction\n' + '\n'.join('\n'.join(readme[s]) if s != 'Copapy' else readme[s][1] for s in [
'Copapy', 'Current state', 'Install', 'License']))
with open(os.path.join(build_dir, 'examples.md'), 'wt') as f:
f.write('\n'.join(readme[s][1] for s in ['Examples',
'Basic example', 'Inverse kinematics']))
with open(os.path.join(build_dir, 'compiler.md'), 'wt') as f:
f.write('\n'.join(readme[s][1] for s in ['How it works']))

View File

@ -1,6 +1,7 @@
```{toctree}
:maxdepth: 1
:hidden:
examples
compiler
api/index
api/backend
@ -8,4 +9,4 @@ repo
```
```{include} ../build/start.md
```
```