[rtems-central commit] specdoc: Add automatically generated warning

Sebastian Huber sebh at rtems.org
Thu Aug 20 14:13:13 UTC 2020


Module:    rtems-central
Branch:    master
Commit:    4ff33d6f657cf6da12060e88283fcb46d7a880b8
Changeset: http://git.rtems.org/rtems-central/commit/?id=4ff33d6f657cf6da12060e88283fcb46d7a880b8

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Wed Aug 19 11:03:48 2020 +0200

specdoc: Add automatically generated warning

---

 rtemsspec/specdoc.py            | 1 +
 rtemsspec/tests/test_specdoc.py | 7 +++++++
 2 files changed, 8 insertions(+)

diff --git a/rtemsspec/specdoc.py b/rtemsspec/specdoc.py
index 1bf3be4..b736867 100644
--- a/rtemsspec/specdoc.py
+++ b/rtemsspec/specdoc.py
@@ -553,6 +553,7 @@ def document(config: dict, item_cache: ItemCache) -> None:
     root_documenter = _Documenter(root_item, documenter_map)
     _gather_item_documenters(root_item, documenter_map)
     content = SphinxContent()
+    content.add_automatically_generated_warning()
     for documenter in documenter_map.values():
         documenter.resolve_used_by()
     documenter_names = set(documenter_map)
diff --git a/rtemsspec/tests/test_specdoc.py b/rtemsspec/tests/test_specdoc.py
index 0e61163..199be3e 100644
--- a/rtemsspec/tests/test_specdoc.py
+++ b/rtemsspec/tests/test_specdoc.py
@@ -48,6 +48,13 @@ def test_document(tmpdir):
 
 .. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 
+.. This file was automatically generated.  Do not edit it manually.
+.. Please have a look at
+..
+.. https://docs.rtems.org/branches/master/eng/req/howto.html
+..
+.. for information how to maintain and re-generate this file.
+
 .. _ReqEngSpecificationItems:
 
 Specification Items



More information about the vc mailing list