Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOCS] Link to configuration chapter #3489

Merged
merged 1 commit into from
Mar 24, 2023
Merged

[DOCS] Link to configuration chapter #3489

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/getting-started/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,12 @@ documentation easier.
phpDocumentor uses an XML-based configuration file with quite a few options; in this document we will go into a few
common uses and how to set this up.

The easiest solution is to place the configuration file in the root of your project with the name
``phpdoc.dist.xml``. This file can be committed to a Revision Control System and thus will the settings always be
available.

.. code-block:: xml
:caption: phpdoc.dist.xml

<?xml version="1.0" encoding="UTF-8" ?>
<phpdocumentor
Expand All @@ -21,6 +26,8 @@ common uses and how to set this up.
</paths>

</phpdocumentor>

Read more about configuation: :doc:`../references/configuration`.

And next
--------
Expand Down