From 460b48fa8190abc2fc9ff1d9b9048b760cf8b8b8 Mon Sep 17 00:00:00 2001
From: Frederik Hennig <frederik.hennig@fau.de>
Date: Thu, 30 Jan 2025 09:36:26 +0100
Subject: [PATCH] minor fixes to the docs
---
docs/source/api/generation.rst | 4 ----
src/pystencilssfg/config.py | 4 ++--
2 files changed, 2 insertions(+), 6 deletions(-)
diff --git a/docs/source/api/generation.rst b/docs/source/api/generation.rst
index 36b5ca0..935e722 100644
--- a/docs/source/api/generation.rst
+++ b/docs/source/api/generation.rst
@@ -30,7 +30,3 @@ Categories, Parameter Types, and Special Values
.. autoclass:: ClangFormatOptions
:members:
-Option Descriptors
-------------------
-
-.. autoclass:: Option
diff --git a/src/pystencilssfg/config.py b/src/pystencilssfg/config.py
index 3b858a5..aae9dab 100644
--- a/src/pystencilssfg/config.py
+++ b/src/pystencilssfg/config.py
@@ -77,9 +77,9 @@ class ClangFormatOptions(ConfigBase):
"""Options affecting the invocation of ``clang-format`` for automatic code formatting."""
code_style: BasicOption[str] = BasicOption("file")
- """Code style to be used by clang-format. Passed verbatim to `--style` argument of the clang-format CLI.
+ """Code style to be used by clang-format. Passed verbatim to ``--style`` argument of the clang-format CLI.
- Similar to clang-format itself, the default value is `file`, such that a `.clang-format` file found in the build
+ Similar to clang-format itself, the default value is ``file``, such that a ``.clang-format`` file found in the build
tree will automatically be used.
"""
--
GitLab