summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdam J. Stewart <ajstewart426@gmail.com>2018-01-10 13:02:33 -0600
committerGitHub <noreply@github.com>2018-01-10 13:02:33 -0600
commit10ee7d6d819289139e981b5594e1f6b8bc624b18 (patch)
treea8615c3f29660331829047e7261fc8dc6fb34f0a
parentda01c8a541164efea01660bab5d76e66cae94b3e (diff)
downloadspack-10ee7d6d819289139e981b5594e1f6b8bc624b18.tar.gz
spack-10ee7d6d819289139e981b5594e1f6b8bc624b18.tar.bz2
spack-10ee7d6d819289139e981b5594e1f6b8bc624b18.tar.xz
spack-10ee7d6d819289139e981b5594e1f6b8bc624b18.zip
Add suggestion to Contribution Guide to activate flake8 (#6886)
-rw-r--r--lib/spack/docs/contribution_guide.rst28
1 files changed, 19 insertions, 9 deletions
diff --git a/lib/spack/docs/contribution_guide.rst b/lib/spack/docs/contribution_guide.rst
index 50eea422d1..2ef27131de 100644
--- a/lib/spack/docs/contribution_guide.rst
+++ b/lib/spack/docs/contribution_guide.rst
@@ -184,7 +184,9 @@ to update them.
Flake8 requires setuptools in order to run. If you installed ``py-flake8``
with Spack, make sure to add ``py-setuptools`` to your ``PYTHONPATH``.
- Otherwise, you will get an error message like:
+ The easiest way to do this is to run ``spack activate py-flake8`` so that
+ all of the dependencies are symlinked to a central location. If you see an
+ error message like:
.. code-block:: console
@@ -193,6 +195,8 @@ to update them.
from pkg_resources import load_entry_point
ImportError: No module named pkg_resources
+ that means Flake8 couldn't find setuptools in your ``PYTHONPATH``.
+
^^^^^^^^^^^^^^^^^^^
Documentation Tests
^^^^^^^^^^^^^^^^^^^
@@ -216,18 +220,24 @@ installed with Spack:
Sphinx has `several required dependencies <https://github.com/spack/spack/blob/develop/var/spack/repos/builtin/packages/py-sphinx/package.py>`_.
If you installed ``py-sphinx`` with Spack, make sure to add all of these
- dependencies to your ``PYTHONPATH``. The easiest way to do this is to run
- ``spack activate py-sphinx`` so that all of the dependencies are symlinked
- to a central location. If you see an error message like:
+ dependencies to your ``PYTHONPATH``. The easiest way to do this is to run:
.. code-block:: console
- Traceback (most recent call last):
- File: "/usr/bin/flake8", line 5, in <module>
- from pkg_resources import load_entry_point
- ImportError: No module named pkg_resources
+ $ spack activate py-sphinx
+ $ spack activate py-sphinxcontrib-programoutput
+
+ so that all of the dependencies are symlinked to a central location.
+ If you see an error message like:
+
+ .. code-block:: console
+
+ Extension error:
+ Could not import extension sphinxcontrib.programoutput (exception: No module named sphinxcontrib.programoutput)
+ make: *** [html] Error 1
- that means Sphinx couldn't find setuptools in your ``PYTHONPATH``.
+ that means Sphinx couldn't find ``py-sphinxcontrib-programoutput`` in your
+ ``PYTHONPATH``.
Once all of the dependencies are installed, you can try building the documentation: