diff --git a/docs/api/frontend.md b/docs/api/frontend.md index c55a25fde21a3f194498ba5bb3ea56c7975d79fc..9c26e7975fc4452615e954b9aadcea45e2f57b98 100644 --- a/docs/api/frontend.md +++ b/docs/api/frontend.md @@ -1,18 +1,10 @@ -# Source File Generator - ::: pystencilssfg.generator.SourceFileGenerator -# Code Generator Configuration - ::: pystencilssfg.configuration.SfgConfiguration -# Generation Context - ::: pystencilssfg.context.SfgContext -# Source File Composition and Components - ::: pystencilssfg.composer.SfgComposer ::: pystencilssfg.source_components.SfgKernelNamespace diff --git a/docs/usage/index.md b/docs/usage/index.md index 945049636cbf7d4981907f715ec91c778efb05bf..0c9b3025bb0140582fdfb7e8551195447183448b 100644 --- a/docs/usage/index.md +++ b/docs/usage/index.md @@ -1,3 +1,5 @@ +# User Guides + These pages provide an overview of how to use the pystencils Source File Generator. A basic understanding of [pystencils](https://pycodegen.pages.i10git.cs.fau.de/pystencils/index.html) is required. diff --git a/mkdocs.yml b/mkdocs.yml index f4eeda8fdaa497e384cb9cdcf2ab4209207d6ba8..4a83ee2603d9bac7d8ddc2e0f4b75cf5f3b9afc8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -36,7 +36,7 @@ markdown_extensions: nav: - Home: index.md - - 'Usage Guide': + - 'User Guides': - 'Overview': usage/index.md - 'Writing Generator Scripts': usage/generator_scripts.md - 'In-Depth: Building Source Files': usage/building.md