From 3baab69baaf9da1beaf2069955eb41382df90868 Mon Sep 17 00:00:00 2001 From: Michael Robinson Date: Tue, 19 Mar 2019 16:55:54 +0000 Subject: [PATCH] Troubleshooting note on building docs inside a virtual env --- docs/contributing/docs.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/contributing/docs.rst b/docs/contributing/docs.rst index e1429d4..b8f6ae8 100644 --- a/docs/contributing/docs.rst +++ b/docs/contributing/docs.rst @@ -60,6 +60,12 @@ Then from the ``docs`` directory, build the HTML: $ make html +If you encounter this error, it's likely that running it in virtual environment is your problem. + +.. code-block:: console + + Error in "currentmodule" directive: + To get started contributing, you'll want to read the :ref:`reStructuredText reference `