[Bf-docboard-svn] bf-manual: [8015] trunk/blender_docs/requirements.txt: Add comments for requirements.txt

Campbell Barton noreply at blender.org
Mon May 10 05:43:25 CEST 2021


Revision: 8015
          https://developer.blender.org/rBM8015
Author:   campbellbarton
Date:     2021-05-10 05:43:25 +0200 (Mon, 10 May 2021)
Log Message:
-----------
Add comments for requirements.txt

Some of the requirements are not hard dependencies,
add notes since it's not obvious what these are used for.

Modified Paths:
--------------
    trunk/blender_docs/requirements.txt

Modified: trunk/blender_docs/requirements.txt
===================================================================
--- trunk/blender_docs/requirements.txt	2021-05-10 03:41:25 UTC (rev 8014)
+++ trunk/blender_docs/requirements.txt	2021-05-10 03:43:25 UTC (rev 8015)
@@ -1,5 +1,13 @@
 sphinx==3.5.3
+
+# Only needed for building translations.
 sphinx-intl==2.0.1
+
+# Only needed to match the theme used for the official documentation.
+# Without this theme, the default theme will be used.
 sphinx_rtd_theme==0.5.2
 
+# Only for convenience, allows live updating while editing RST files.
+# Access by running:
+#   make livehtml
 sphinx-autobuild



More information about the Bf-docboard-svn mailing list