summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-08-19 11:03:48 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-08-19 11:29:34 +0200
commit4ff33d6f657cf6da12060e88283fcb46d7a880b8 (patch)
tree800846fdaae18cb9a71455b3ee61c56bdf9b04b1
parentcontent: Add add_automatically_generated_warning() (diff)
downloadrtems-central-4ff33d6f657cf6da12060e88283fcb46d7a880b8.tar.bz2
specdoc: Add automatically generated warning
-rw-r--r--rtemsspec/specdoc.py1
-rw-r--r--rtemsspec/tests/test_specdoc.py7
2 files changed, 8 insertions, 0 deletions
diff --git a/rtemsspec/specdoc.py b/rtemsspec/specdoc.py
index 1bf3be42..b736867e 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 0e611634..199be3ea 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