From 2d0eac339e3e31fa0c993fd3139b8408ac66066b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9goire=20Paris?= Date: Sat, 28 Sep 2024 12:06:48 +0200 Subject: [PATCH 1/4] Use the proper syntax for links --- docs/en/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/index.rst b/docs/en/index.rst index ef173ffa9..70f6f7555 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -11,7 +11,7 @@ We do not recommend using this library in new projects and encourage authors of downstream libraries to offer support for attributes as an alternative to Doctrine Annotations. -Have a look at [our blog](https://www.doctrine-project.org/2022/11/04/annotations-to-attributes.html) +Have a look at `our blog `_ to learn more. Introduction From 609f2de54fe9711e84e55b732884fb4d9cd57d1b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9goire=20Paris?= Date: Sat, 28 Sep 2024 12:07:12 +0200 Subject: [PATCH 2/4] Replace :ref: with :doc: It seems guides does not render those properly. Anyway, I do not see a reason to use such a convoluted and error-prone way of building a link. --- docs/en/index.rst | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/docs/en/index.rst b/docs/en/index.rst index 70f6f7555..8df892bf5 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -66,7 +66,7 @@ looks like this: The annotation class is declared as an annotation by ``@Annotation``. -:ref:`Read more about custom annotations. ` +:doc:`Read more about custom annotations. ` Reading annotations =================== @@ -98,12 +98,12 @@ annotations of a class. A common one is Note that ``AnnotationRegistry::registerLoader('class_exists')`` only works if you already have an autoloader configured (i.e. composer autoloader). -Otherwise, :ref:`please take a look to the other annotation autoload mechanisms `. +Otherwise, :doc:`please take a look to the other annotation autoload mechanisms `. A reader has multiple methods to access the annotations of a class or function. -:ref:`Read more about handling annotations. ` +:doc:`Read more about handling annotations. ` IDE Support ----------- @@ -112,6 +112,3 @@ Some IDEs already provide support for annotations: - Eclipse via the `Symfony2 Plugin `_ - PhpStorm via the `PHP Annotations Plugin `_ or the `Symfony Plugin `_ - -.. _Read more about handling annotations.: annotations -.. _Read more about custom annotations.: custom From ae911241f9333af82b946e3e2fd11da7e4690c13 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9goire=20Paris?= Date: Sat, 28 Sep 2024 12:08:16 +0200 Subject: [PATCH 3/4] Mark the sidebar as orphan --- docs/en/sidebar.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/en/sidebar.rst b/docs/en/sidebar.rst index 6f5d13c46..595dabfab 100644 --- a/docs/en/sidebar.rst +++ b/docs/en/sidebar.rst @@ -1,3 +1,5 @@ +:orphan: + .. toctree:: :depth: 3 From 522e104e859b36d77ecc5f63f424f3616538561c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9goire=20Paris?= Date: Sat, 28 Sep 2024 13:15:44 +0200 Subject: [PATCH 4/4] Setup documentation workflow --- .github/workflows/documentation.yml | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 .github/workflows/documentation.yml diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 000000000..e9b2c7185 --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,20 @@ +name: "Documentation" + +on: + pull_request: + branches: + - "*.x" + paths: + - ".github/workflows/documentation.yml" + - "docs/**" + push: + branches: + - "*.x" + paths: + - ".github/workflows/documentation.yml" + - "docs/**" + +jobs: + documentation: + name: "Documentation" + uses: "doctrine/.github/.github/workflows/documentation.yml@5.1.0"