Skip to content

Commit

Permalink
docs: document graphviz requirement to build docs
Browse files Browse the repository at this point in the history
Fixes #10636
  • Loading branch information
nijel committed Jun 19, 2024
1 parent 942d963 commit 96a91b8
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
7 changes: 7 additions & 0 deletions ci/run-docs
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,12 @@

set -e

if ! command -v dot &> /dev/null
then
echo "dot command could not be found, please install graphviz"
exit 1
fi


# Build documentation with warnings treated as errors
make -C docs "${1:-html}" SPHINXOPTS='-n -W -a --keep-going'
4 changes: 4 additions & 0 deletions docs/contributing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ Please respect these guidelines while writing:
1. Rewrite
2. Once the rewrite is reviewed, polished, and merged, change the structure of the paragraphs in another PR.

Documentation can be also edited and built locally, the Python requirements are
in `docs/requirements.txt`. You will also need :program:`graphviz` to build the
documentation.

.. hint::

You can `translate the docs <https://hosted.weblate.org/projects/weblate/documentation/>`_.
Expand Down

0 comments on commit 96a91b8

Please sign in to comment.