Merge pull request #11984 from doctrine/2.20.x

Merge 2.20.x up into 3.3.x

Author: greg0ire

.github/workflows/coding-standards.yml

@@ -24,4 +24,4 @@ on:
 
 jobs:
   coding-standards:
-    uses: "doctrine/.github/.github/workflows/coding-standards.yml@7.2.2"
+    uses: "doctrine/.github/.github/workflows/coding-standards.yml@7.3.0"

.github/workflows/documentation.yml

@@ -17,4 +17,4 @@ on:
 jobs:
   documentation:
     name: "Documentation"
-    uses: "doctrine/.github/.github/workflows/documentation.yml@7.2.2"
+    uses: "doctrine/.github/.github/workflows/documentation.yml@7.3.0"

.github/workflows/release-on-milestone-closed.yml

@@ -7,7 +7,7 @@ on:
 
 jobs:
   release:
-    uses: "doctrine/.github/.github/workflows/release-on-milestone-closed.yml@7.2.2"
+    uses: "doctrine/.github/.github/workflows/release-on-milestone-closed.yml@7.3.0"
     secrets:
       GIT_AUTHOR_EMAIL: ${{ secrets.GIT_AUTHOR_EMAIL }}
       GIT_AUTHOR_NAME: ${{ secrets.GIT_AUTHOR_NAME }}

docs/.gitignore

@@ -0,0 +1,3 @@
+composer.lock
+vendor/
+build/

docs/Makefile

@@ -0,0 +1,24 @@
+# Makefile for Doctrine ORM documentation
+#
+
+# You can set these variables from the command line.
+DOCOPTS  =
+BUILD    = vendor/bin/guides
+BUILDDIR = build
+
+# Internal variables.
+ALLGUIDESOPTS   = $(DOCOPTS) en/
+
+.PHONY: help clean html
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html      to make standalone HTML files"
+
+clean:
+	-rm -rf ./$(BUILDDIR)/*
+
+html:
+	$(BUILD) $(ALLGUIDESOPTS) --output=$(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

docs/README.md

@@ -1,18 +1,22 @@
 # Doctrine ORM Documentation
 
+The documentation is written in [ReStructured Text](https://docutils.sourceforge.io/rst.html).
+
 ## How to Generate:
-Using Ubuntu 14.04 LTS:
 
-1. Run ./bin/install-dependencies.sh
-2. Run ./bin/generate-docs.sh
+In the `docs/` folder, run
+
+    composer update
+
+Then compile the documentation with:
 
-It will generate the documentation into the build directory of the checkout.
+    make html
 
+This will generate the documentation into the `build` subdirectory.
 
-## Theme issues
+To browse the documentation, you need to run a webserver:
 
-If you get a "Theme error", check if the `en/_theme` subdirectory is empty,
-in which case you will need to run:
+    cd build/html
+    php -S localhost:8000
 
-1. git submodule init
-2. git submodule update
+Now the documentation is available at [http://localhost:8000](http://localhost:8000).

docs/bin/generate-docs.sh

@@ -0,0 +1,10 @@
+{
+    "name": "doctrine/orm-docs",
+    "description": "Documentation for the Object-Relational Mapper\"",
+    "type": "library",
+    "license": "MIT",
+    "require": {
+        "phpdocumentor/guides-cli": "1.7.1",
+        "phpdocumentor/filesystem": "1.7.1"
+    }
+}