Skip to content

Commit

Permalink
[TASK] Introduce Makefile and command 'make docs'
Browse files Browse the repository at this point in the history
This is more convenient then having to copy-paste the command all the time
  • Loading branch information
linawolf committed Jan 21, 2024
1 parent 5789ddc commit 0c79910
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
13 changes: 11 additions & 2 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@ Contributing
Information About Contributing to This Manual
=============================================

Local rendering
---------------

You can render this file locally if you have `Docker <https://www.docker.com/>`
and `make <https://www.gnu.org/software/make/>` installed on your local
machine::

make docs

Create Issues
-------------

Expand All @@ -21,10 +30,10 @@ Make changes (create pull requests)
`rendered page <https://docs.typo3.org/typo3cms/HowToDocument/Index.html>`__,
just click on "Edit me on GitHub".
* Step-by-step walkthrough of making a change by `Editing Directly on GitHub
<https://docs.typo3.org/typo3cms/HowToDocument/WritingDocsOfficial/Index.html>`__
<https://docs.typo3.org/typo3cms/HowToDocument/WritingDocsOfficial/Index.html>`__
(this requires only a browser)
* Step-by-step walkthrough of `Local Editing and Rendering with Docker
<https://docs.typo3.org/typo3cms/HowToDocument/WritingDocsOfficial/LocalEditing.html>`__
<https://docs.typo3.org/typo3cms/HowToDocument/WritingDocsOfficial/LocalEditing.html>`__
(this requires knowledge of Git and Docker)

* See `Writing Documentation <https://docs.typo3.org/typo3cms/HowToDocument/>`__ for further
Expand Down
11 changes: 11 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.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 0c79910

Please sign in to comment.