From df29627983fc6c8ce90c42afd59d3dbf4ef3c867 Mon Sep 17 00:00:00 2001 From: tobi-wan-kenobi Date: Sat, 18 Jul 2020 08:14:23 +0200 Subject: [PATCH] [core/doc] add autogenerated warning to modules.rst --- bumblebee_status/core/config.py | 5 +++++ docs/modules.rst | 2 ++ 2 files changed, 7 insertions(+) diff --git a/bumblebee_status/core/config.py b/bumblebee_status/core/config.py index 94a92e5..c84d10c 100644 --- a/bumblebee_status/core/config.py +++ b/bumblebee_status/core/config.py @@ -71,6 +71,11 @@ class print_usage(argparse.Action): ) rst = {} + + if self._format == "rst": + print(".. THIS DOCUMENT IS AUTO-GENERATED, DO NOT MODIFY") + print(".. To change this document, please update the docstrings in the individual modules") + for m in all_modules(): try: module_type = "core" diff --git a/docs/modules.rst b/docs/modules.rst index a258899..048eeeb 100644 --- a/docs/modules.rst +++ b/docs/modules.rst @@ -1,3 +1,5 @@ +.. THIS DOCUMENT IS AUTO-GENERATED, DO NOT MODIFY +.. To change this document, please update the docstrings in the individual modules List of modules ===============