diff --git a/documentation/Pipfile b/documentation/Pipfile index 7ee1d22905..e631741ad6 100644 --- a/documentation/Pipfile +++ b/documentation/Pipfile @@ -4,6 +4,8 @@ url = "https://pypi.org/simple" verify_ssl = true [dev-packages] +sphinx-lint = "*" +vale = "*" [packages] sphinx = "*" diff --git a/documentation/README b/documentation/README index c394ab9288..f498da171e 100644 --- a/documentation/README +++ b/documentation/README @@ -151,6 +151,13 @@ dependencies in a virtual environment: $ pipenv install $ pipenv run make html +Note: if you decide to use Pipenv for installing the dependencies, don't forget +to prefix all the make commands below with "pipenv run ". The make commands +which already start with "pipenv run " don't need to be prefixed a second time +but require you to use Pipenv for them to run and aren't available when +following the instructions from +https://docs.yoctoproject.org/dev/ref-manual/system-requirements.html#required-packages-for-the-build-host. + Style checking the Yocto Project documentation ============================================== @@ -159,19 +166,19 @@ to validate the text style. To install Vale: - $ pip install vale + $ pipenv install --dev To run Vale: - $ make stylecheck + $ pipenv run make stylecheck Style checking the whole documentation might take some time and generate a lot of warnings/errors, thus one can run Vale on a subset of files or directories: - $ make stylecheck VALEDOCS= - $ make stylecheck VALEDOCS=" " - $ make stylecheck VALEDOCS= + $ pipenv run make stylecheck VALEDOCS= + $ pipenv run make stylecheck VALEDOCS=" " + $ pipenv run make stylecheck VALEDOCS= Lint checking the Yocto Project documentation ============================================= @@ -181,19 +188,19 @@ the project uses sphinx-lint (https://github.com/sphinx-contrib/sphinx-lint). To install sphinx-lint: - $ pip install sphinx-lint + $ pipenv install --dev To run sphinx-lint: - $ make sphinx-lint + $ pipenv run make sphinx-lint Lint checking the whole documentation might take some time and generate a lot of warnings/errors, thus one can run sphinx-lint on a subset of files or directories: - $ make sphinx-lint SPHINXLINTDOCS= - $ make sphinx-lint SPHINXLINTDOCS=" " - $ make sphinx-lint SPHINXLINTDOCS= + $ pipenv run make sphinx-lint SPHINXLINTDOCS= + $ pipenv run make sphinx-lint SPHINXLINTDOCS=" " + $ pipenv run make sphinx-lint SPHINXLINTDOCS= Sphinx theme and CSS customization ==================================