Move warning

adamboche · Feb 2, 2020 · eacccb8 · eacccb8
1 parent 53d2ce9
commit eacccb8
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 8 deletions.
diff --git a/README.rst b/README.rst
@@ -61,6 +61,8 @@ Union fields for marshmallow.
 * Free software: MIT license
 
 
+.. include:: warning.rst
+
 Documentation
 =============
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -2,6 +2,7 @@
 from __future__ import unicode_literals
 
 import os
+import pathlib
 
 
 extensions = [
@@ -55,11 +56,4 @@
 autoapi_dirs = ["../src/marshmallow_union"]
 
 
-rst_prolog = """
-.. warning::
-
-   Figuring out the correct field type from an untagged dump is a matter of guesswork and
-   can be error-prone. A more explicit approach like
-   https://github.com/Bachmann1234/marshmallow-polyfield/ is better. This project remains
-   here to avoid breaking existing software.
-"""
+rst_prolog = pathlib.Path(__file__).parent.parent.joinpath("warning.rst").read_text()
diff --git a/warning.rst b/warning.rst
@@ -0,0 +1,6 @@
+.. warning::
+
+   Figuring out the correct field type from an untagged dump is a matter of guesswork and
+   can be error-prone. A more explicit approach like
+   https://github.com/Bachmann1234/marshmallow-polyfield/ is better. This project remains
+   here to avoid breaking existing software.