Skip to content

Commit

Permalink
Revert "Simplify docs and REAMDE even more"
Browse files Browse the repository at this point in the history
This reverts commits 8ceb0e8.
and fd97983.
  • Loading branch information
n-peugnet committed Jun 13, 2024
1 parent 7a0251e commit 5d62f35
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ and can be installed via `composer <https://getcomposer.org/>`_:
Simple example
--------------

The simplest way to use it is with :meth:`SphinxInventoryParser::parseFromDoc()`
that creates a :class:`SphinxInventory` object directly from an online documentation,
The simplest way to use it is with |SphinxInventoryParser::parseFromDoc()|
that creates a |SphinxInventory| object directly from an online documentation,
based on its URL (and an optional inventory path).

.. code:: php
Expand Down Expand Up @@ -87,6 +87,9 @@ Build scripts
.. Epilog .. ..................................................................
.. |SphinxInventoryParser::parseFromDoc()| replace:: ``SphinxInventoryParser::parseFromDoc()``
.. |SphinxInventory| replace:: ``SphinxInventory``

.. |License LGPL-2.1-or-later| image:: https://img.shields.io/badge/license-LGPL--2.1--or--later-blue.svg
:target: LICENSE
.. |PHP versions tested| image:: https://img.shields.io/badge/php-7.4%20%7C%208.0%20%7C%208.1%20%7C%208.2%20%7C%208.3-blue.svg
Expand Down
3 changes: 3 additions & 0 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ so there are multiple ways to use it.
:start-after: .. Example
:end-before: .. Documentation

.. |SphinxInventoryParser::parseFromDoc()| replace:: :meth:`SphinxInventoryParser::parseFromDoc()`
.. |SphinxInventory| replace:: :class:`SphinxInventory`

Using an existing stream
------------------------

Expand Down

0 comments on commit 5d62f35

Please sign in to comment.