Troubleshooting note on building docs inside a virtual env

This commit is contained in:
Michael Robinson
2019-03-19 16:55:54 +00:00
parent 98090098ca
commit 3baab69baa

View File

@@ -60,6 +60,12 @@ Then from the ``docs`` directory, build the HTML:
$ make 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 To get started contributing, you'll want to read the :ref:`reStructuredText
reference <sphinx:rst-index>` reference <sphinx:rst-index>`