From b906316edc0c075b58aff425ee9ef4b1f4b5a0d9 Mon Sep 17 00:00:00 2001
From: Frederik Hennig <frederik.hennig@fau.de>
Date: Thu, 30 Nov 2023 08:06:53 +0100
Subject: [PATCH] minor fixes to documentation
---
docs/api/frontend.md | 8 --------
docs/usage/index.md | 2 ++
mkdocs.yml | 2 +-
3 files changed, 3 insertions(+), 9 deletions(-)
diff --git a/docs/api/frontend.md b/docs/api/frontend.md
index c55a25f..9c26e79 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 9450496..0c9b302 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 f4eeda8..4a83ee2 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
--
GitLab