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" diff --git a/docs/en/index.rst b/docs/en/index.rst index 3cf37e504..875ba4240 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 @@ -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 =================== @@ -95,7 +95,7 @@ annotations of a class. A common one is 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 ----------- @@ -104,6 +104,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 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