Skip to content
This repository was archived by the owner on Apr 8, 2025. It is now read-only.

Commit e733fe1

Browse files
committed
update message
1 parent 4a41033 commit e733fe1

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

readthedocs_ext/external_version_warning.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,14 @@
1717

1818

1919
def process_external_version_warning_banner(app, doctree, fromdocname):
20+
"""
21+
Add the ability to warning banner for external versions in every page.
22+
23+
If the version type is external this will show a warning banner
24+
at the top of each page of the documentation.
25+
"""
2026
for document in doctree.traverse(nodes.document):
21-
text = 'This is an External Version created from pull/merge request.'
27+
text = 'This Documentation was created from pull/merge request.'
2228
prose = nodes.paragraph(text, text)
2329
warning = nodes.warning(prose, prose)
2430
document.insert(0, warning)

0 commit comments

Comments
 (0)