mirror of https://github.com/Nonannet/copapy.git
Doc structure updated: examples moved in a separate section
This commit is contained in:
parent
70b916cc34
commit
c744e380af
|
|
@ -9,4 +9,4 @@ example_asm
|
||||||
```{include} ../build/compiler.md
|
```{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).
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,4 @@
|
||||||
|
# Examples
|
||||||
|
|
||||||
|
```{include} ../build/examples.md
|
||||||
|
```
|
||||||
|
|
@ -62,9 +62,12 @@ if __name__ == '__main__':
|
||||||
readme = extract_sections(f.read())
|
readme = extract_sections(f.read())
|
||||||
|
|
||||||
with open(os.path.join(build_dir, 'start.md'), 'wt') as f:
|
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 [
|
f.write('# Introduction\n' + '\n'.join('\n'.join(readme[s]) if s != 'Copapy' else readme[s][1] for s in [
|
||||||
'Copapy', 'Current state', 'Install', 'Examples',
|
'Copapy', 'Current state', 'Install', 'License']))
|
||||||
'Basic example', 'Inverse kinematics', '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:
|
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']))
|
f.write('\n'.join(readme[s][1] for s in ['How it works']))
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,7 @@
|
||||||
```{toctree}
|
```{toctree}
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
:hidden:
|
:hidden:
|
||||||
|
examples
|
||||||
compiler
|
compiler
|
||||||
api/index
|
api/index
|
||||||
api/backend
|
api/backend
|
||||||
|
|
@ -8,4 +9,4 @@ repo
|
||||||
```
|
```
|
||||||
|
|
||||||
```{include} ../build/start.md
|
```{include} ../build/start.md
|
||||||
```
|
```
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue