summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMatthäus G. Chajdas <dev@anteru.net>2022-07-26 10:24:42 +0200
committerMatthäus G. Chajdas <dev@anteru.net>2022-07-26 10:24:42 +0200
commit670429bdc531542a557d528705b643d4abd16a7c (patch)
treec999bc797b4597f056e6b461b101546b72a50d82 /doc
parentf162631a2504b63799c9466f12072f9fd14611b1 (diff)
downloadpygments-git-670429bdc531542a557d528705b643d4abd16a7c.tar.gz
Improve documentation.
Explain that adding styles to the source tree directly is something that should be only used by contributors.
Diffstat (limited to 'doc')
-rw-r--r--doc/docs/styledevelopment.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/docs/styledevelopment.rst b/doc/docs/styledevelopment.rst
index b75465bf..8c4ec2de 100644
--- a/doc/docs/styledevelopment.rst
+++ b/doc/docs/styledevelopment.rst
@@ -50,6 +50,13 @@ To make the style usable for Pygments, you must
...
'your': 'your::YourStyle',
+.. note::
+
+ You should *only* add it to the ``pygments.styles`` subdirectory if you are
+ working on a contribution to Pygments. You should not use that
+ method to extend an already existing copy of Pygments, use the plugins
+ mechanism for that.
+
Style Rules
===========