diff options
| author | Quentin Young <qlyoung@cumulusnetworks.com> | 2018-02-02 16:59:52 -0500 |
|---|---|---|
| committer | Quentin Young <qlyoung@cumulusnetworks.com> | 2018-02-02 16:59:52 -0500 |
| commit | c91e9b8f74f7d7cad5fa607eb71fb64225534c85 (patch) | |
| tree | f31264168ad03f810a73736559c316e196abad2e | |
| parent | 5a32c42459ea04b7a8b666745e55528edc57b302 (diff) | |
doc: note dependencies necessary to build docs
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
| -rw-r--r-- | doc/developer/workflow.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst index 1f33a51adc..e1101fd76a 100644 --- a/doc/developer/workflow.rst +++ b/doc/developer/workflow.rst @@ -550,6 +550,11 @@ The documentation is currently incomplete and needs love. If you find a broken cross-reference, figure, dead hyperlink, style issue or any other nastiness we gladly accept documentation patches. +To build the docs, please ensure you have installed a recent version of +`Sphinx <http://www.sphinx-doc.org/en/stable/install.html>`_. If you want to +build LaTeX or PDF docs, you will also need a full LaTeX distribution +installed. + Code ---- |