added comments to readthedocsyaml

vngrs-ai · Mar 2, 2023 · aaeae7a · aaeae7a
1 parent a7ad94d
commit aaeae7a
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -17,6 +17,8 @@ sphinx:
   builder: html
   configuration: docs/source/conf.py
 
+# First installation is the packages required by readthedocs build
+# Second installation is to install vngrs-nlp while building the documentation, otherwise the docstrings are not parsed.
 python:
    install:
     - requirements: docs/requirements.txt