Skip to content

Commit

Permalink
Merge pull request #913 from phpDocumentor/task/activate-docs-warnings
Browse files Browse the repository at this point in the history
[TASK] Use Fail-On-Log for our docs again
  • Loading branch information
jaapio authored Mar 9, 2024
2 parents db49faa + abd9571 commit f9d8964
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ jobs:
dependency-versions: "highest"

- name: "Run guides-cli"
run: "vendor/bin/guides -vvv --no-progress docs --output='/tmp/test' --fail-on-error"
run: "vendor/bin/guides -vvv --no-progress docs --output='/tmp/test' --fail-on-log"
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ test-xml: ## Lint all guides.xml

.PHONY: test-docs
test-docs: ## Generate projects docs without errors
$(PHP_BIN) vendor/bin/guides -vvv --no-progress docs --output="/tmp/test" --fail-on-error
$(PHP_BIN) vendor/bin/guides -vvv --no-progress docs --output="/tmp/test" --fail-on-log

.PHONY: cleanup
cleanup: cleanup-tests cleanup-build cleanup-cache
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Create your first documentation
After :doc:`/installation` you can directly start to create your first documentation.
to do this, create a new directory named ``docs`` and create a file called ``index.rst`` in it.

.. code-block:: rst
.. code-block:: text
My first documentation
======================
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/restructuredtext/text-roles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Examples

:ref:`Reference somewhere <basic-text-role>`

:doc:`Reference to document </extension/text-roles>`
:doc:`Reference to document </reference/restructuredtext/text-roles>`

:code:`Lorem Ipsum`

Expand Down

0 comments on commit f9d8964

Please sign in to comment.