Skip to content

Commit 9f76038

Browse files
committed
Added Sami configuration file and .gitattributes that makes Composer ignore non-essentials when preferring distribution;
All documentation generators now generate files in "Reference/{{generator}}/Doc".
1 parent 753c616 commit 9f76038

File tree

5 files changed

+39
-4
lines changed

5 files changed

+39
-4
lines changed

.gitattributes

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
*.php text eol=lf
2+
/docs export-ignore
3+
/examples export-ignore
4+
/tests export-ignore
5+
.gitattributes export-ignore
6+
.gitignore export-ignore
7+
.scrutinizer.yml export-ignore
8+
.travis.yml export-ignore
9+
README.md export-ignore
10+
README export-ignore
11+
CREDITS export-ignore
12+
RELEASE-* export-ignore
13+
package.xml export-ignore
14+
packagexmlsetup.php export-ignore
15+
extrasetup.php export-ignore

docs/apigen.neon

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
source: ../src
22

3-
destination: PEAR2_Net_RouterOS__ApiGen_Documentation
3+
destination: Reference/ApiGen/Doc
44

55
extensions: php
66

docs/doxygen.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ PROJECT_LOGO =
5252
# If a relative path is entered, it will be relative to the location
5353
# where doxygen was started. If left blank the current directory will be used.
5454

55-
OUTPUT_DIRECTORY = "PEAR2_Net_RouterOS__Doxygen_Documentation"
55+
OUTPUT_DIRECTORY = "Reference/Doxygen/Doc"
5656

5757
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
5858
# 4096 sub-directories (in 2 levels) under the output directory of each output

docs/phpdoc.dist.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<title>PEAR2_Net_RouterOS documentation</title>
44
<parser>
55
<default-package-name>PEAR2_Net_RouterOS</default-package-name>
6-
<target>PEAR2_Net_RouterOS__PhpDocumentor_Cache</target>
6+
<target>Reference/PhpDocumentor/Cache</target>
77
<extensions>
88
<extension>php</extension>
99
</extensions>
@@ -12,6 +12,6 @@
1212
<directory>../src/PEAR2/Net/RouterOS</directory>
1313
</files>
1414
<transformer>
15-
<target>PEAR2_Net_RouterOS__PhpDocumentor_Documentation</target>
15+
<target>Reference/PhpDocumentor/Doc</target>
1616
</transformer>
1717
</phpdoc>

docs/sami.php

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<?php
2+
use Sami\Sami;
3+
use Sami\Version\GitVersionCollection;
4+
use Symfony\Component\Finder\Finder;
5+
6+
return new Sami(
7+
Finder::create()
8+
->files()
9+
->name('*.php')
10+
->exclude('docs')
11+
->exclude('examples')
12+
->exclude('tests')
13+
->in($dir = dirname(__DIR__)),
14+
array(
15+
'title' => 'PEAR2_Net_RouterOS documentation',
16+
'build_dir' => __DIR__ . '/Reference/Sami/Doc',
17+
'cache_dir' => __DIR__ . '/Reference/Sami/Cache',
18+
'default_opened_level' => 1
19+
)
20+
);

0 commit comments

Comments
 (0)