openstack
/
openstack-manuals
Code Issues Proposed changes

Adding a note regarding running bindep per project 

As I sadly found out yesterday, new users will have to
run bindep on each individual repo they clone if they wish
to build project documentation. This is obvious to those
who have been working on the project forever, but this was
my first new computer in 5 years and I was pretty stumped -
couldn't work out why I needed liberasure to build swift
docs but here we are.

Change-Id: I27fb8ed862f3c2dfafba5f2d916a8c99fce7ec10
This commit is contained in:
Alexandra Settle 2019-02-14 12:32:53 +00:00 committed by Alexandra Settle
parent 06da4716d6
commit 695774e246
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/doc-contrib-guide/source/docs-builds.rst
View File

@ -45,6 +45,14 @@ dependencies based on the error messages returned. Continue to run until
your local environment meets the requirements as listed in ``bindep.txt``
in the repository.
.. important::
Ensure you run ``bindep`` in each individual project repository that you
clone if you want to build the documentation.
For more information on ``bindep`` and packages, see `Package Requirements
<https://docs.openstack.org/infra/manual/drivers.html#package-requirements>`_.
* On Ubuntu or Debian:
.. code-block:: console