diff --git a/docs/source/compiler.md b/docs/source/compiler.md index faab63c..3f53feb 100644 --- a/docs/source/compiler.md +++ b/docs/source/compiler.md @@ -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). \ No newline at end of file +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). diff --git a/docs/source/examples.md b/docs/source/examples.md new file mode 100644 index 0000000..a97fd91 --- /dev/null +++ b/docs/source/examples.md @@ -0,0 +1,4 @@ +# Examples + +```{include} ../build/examples.md +``` diff --git a/docs/source/extract_section.py b/docs/source/extract_section.py index 6b85605..f73b1a7 100644 --- a/docs/source/extract_section.py +++ b/docs/source/extract_section.py @@ -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'])) diff --git a/docs/source/index.md b/docs/source/index.md index bc346d8..8745fee 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -1,6 +1,7 @@ ```{toctree} :maxdepth: 1 :hidden: +examples compiler api/index api/backend @@ -8,4 +9,4 @@ repo ``` ```{include} ../build/start.md -``` \ No newline at end of file +```