Skip to content

Commit

Permalink
[DOCS] Fix warnings, create makefile for easy doc rendering
Browse files Browse the repository at this point in the history
  • Loading branch information
linawolf committed Feb 17, 2024
1 parent afb0f81 commit d492bbe
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 5 deletions.
11 changes: 11 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,17 @@ email, or any other method with the owners of this repository before making a ch

For changes of a trivial nature, it is not always necessary to create a new issue.

## Render the documentation locally

To render the documentation locally you can use the following `make` command:

```
make docs
```

If `make` is not available on your machine you can also call the commands provided
in the file `Makefile` manually.

## Additional resources

* [Rendered documentation](https://docs.typo3.org/p/georgringer/news/main/en-us/)
Expand Down
2 changes: 0 additions & 2 deletions Documentation/Index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.. include:: /Includes.rst.txt

.. _start:

===========
Expand Down
1 change: 0 additions & 1 deletion Documentation/Misc/Changelog/11-4-0.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: /Includes.rst.txt

11.4.0 - 8th February 2024
==========================
Expand Down
1 change: 0 additions & 1 deletion Documentation/Misc/Changelog/11-4-1.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: /Includes.rst.txt

11.4.1 - 8th February 2024
==========================
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: /Includes.rst.txt

.. _viewHelperRenderMedia:

Expand Down
10 changes: 10 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.PHONY: help
help: ## Displays this list of targets with descriptions
@echo "The following commands are available:\n"
@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}'

.PHONY: docs
docs: ## Generate projects docs (from "Documentation" directory)
mkdir -p Documentation-GENERATED-temp

docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation

0 comments on commit d492bbe

Please sign in to comment.