Skip to content

Commit

Permalink
Merge pull request #501 from greg0ire/doc-fixes
Browse files Browse the repository at this point in the history
Doc fixes
  • Loading branch information
greg0ire authored Sep 29, 2024
2 parents 253dca4 + ae91124 commit 9d7d63b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
11 changes: 4 additions & 7 deletions docs/en/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.doctrine-project.org/2022/11/04/annotations-to-attributes.html>`_
to learn more.

Introduction
Expand Down Expand Up @@ -66,7 +66,7 @@ looks like this:
The annotation class is declared as an annotation by ``@Annotation``.

:ref:`Read more about custom annotations. <custom>`
:doc:`Read more about custom annotations. <custom>`

Reading annotations
===================
Expand Down Expand Up @@ -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 <annotations>`.
Otherwise, :doc:`please take a look to the other annotation autoload mechanisms <annotations>`.

A reader has multiple methods to access the annotations of a class or
function.

:ref:`Read more about handling annotations. <annotations>`
:doc:`Read more about handling annotations. <annotations>`

IDE Support
-----------
Expand All @@ -112,6 +112,3 @@ Some IDEs already provide support for annotations:

- Eclipse via the `Symfony2 Plugin <https://github.com/pulse00/Symfony-2-Eclipse-Plugin>`_
- PhpStorm via the `PHP Annotations Plugin <https://plugins.jetbrains.com/plugin/7320-php-annotations>`_ or the `Symfony Plugin <https://plugins.jetbrains.com/plugin/7219-symfony-support>`_

.. _Read more about handling annotations.: annotations
.. _Read more about custom annotations.: custom
2 changes: 2 additions & 0 deletions docs/en/sidebar.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. toctree::
:depth: 3

Expand Down

0 comments on commit 9d7d63b

Please sign in to comment.