Browse Source

feat(docs) Add autogeneration notices

Mark Story 6 years ago
parent
commit
96ce1dbbc4
2 changed files with 4 additions and 0 deletions
  1. 2 0
      api-docs/generator.py
  2. 2 0
      src/sentry/templates/sentry/apidocs/index.md

+ 2 - 0
api-docs/generator.py

@@ -289,6 +289,8 @@ def dump_markdown(path, data):
         pass
     with open(path, 'w') as f:
         template = u"""---
+# This file is automatically generated from the API using `api-docs/generate.py`
+# Do not manually this file.
 {}
 ---
 """

+ 2 - 0
src/sentry/templates/sentry/apidocs/index.md

@@ -1,4 +1,6 @@
 ---
+# This file is automatically generated from the API using `api-docs/generate.py`
+# Do not manually edit this file.
 title: {{ title }}
 ---