Browse Source

agrego configuracion para php documentor

main
jirho 7 months ago
parent
commit
46c85b3cc1
  1. 2
      .gitignore
  2. 3
      README.md
  3. 18
      phpdoc.xml

2
.gitignore vendored

@ -6,3 +6,5 @@ auth.json
/.idea
/.vscode
.env
cache/
docs/

3
README.md

@ -2,6 +2,8 @@
[Documentación de las rutas de la API](https://documenter.getpostman.com/view/28160221/2sA3JDh5PC#c1acf864-e310-4856-a2f8-17ba05a5b88a)
Existe documentacón del codigo generada con PHP Documentor comprimida y subida a este repositorio.
## Intrucciones puesta en funcionamiento:
Existen 2 archivos docker-compose, desarrollo (dentro de src/ ) y producción ( en la raíz del proyecto).
@ -51,4 +53,3 @@ Dentro del contenedor ejecute lo siguiente para que el sistema funcione correcta
$ php artisan key:generate
$ php artisan optimize
```

18
phpdoc.xml

@ -0,0 +1,18 @@
<?xml version="1.0" encoding="UTF-8" ?>
<phpdocumentor configVersion="3"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="https://www.phpdoc.org"
xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/phpDocumentor/phpDocumentor/master/data/xsd/phpdoc.xsd">
<paths>
<output>docs</output>
<cache>cache</cache>
</paths>
<version number="1.0.0">
<api>
<source dsn=".">
<path>src</path>
</source>
</api>
</version>
</phpdocumentor>
Loading…
Cancel
Save