mirror of
https://github.com/symfony/symfony-docs.git
synced 2026-03-24 00:32:14 +01:00
f839b2fe79
* 6.4: Update the links related to X-Sendfile and X-Accel-Redirect Update the build script to mention that it does not support Windows
92 lines
4.0 KiB
PHP
Executable File
92 lines
4.0 KiB
PHP
Executable File
#!/usr/bin/env php
|
|
<?php
|
|
require __DIR__.'/vendor/autoload.php';
|
|
|
|
use Symfony\Component\Console\Application;
|
|
use Symfony\Component\Console\Input\InputInterface;
|
|
use Symfony\Component\Console\Output\OutputInterface;
|
|
use Symfony\Component\Console\Input\InputOption;
|
|
use Symfony\Component\Console\Style\SymfonyStyle;
|
|
use SymfonyDocsBuilder\BuildConfig;
|
|
use SymfonyDocsBuilder\DocBuilder;
|
|
|
|
(new Application('Symfony Docs Builder', '1.0'))
|
|
->register('build-docs')
|
|
->addOption('generate-fjson-files', null, InputOption::VALUE_NONE, 'Use this option to generate docs both in HTML and JSON formats')
|
|
->addOption('disable-cache', null, InputOption::VALUE_NONE, 'Use this option to force a full regeneration of all doc contents')
|
|
->setCode(function(InputInterface $input, OutputInterface $output) {
|
|
// the doc building app doesn't work on Windows
|
|
if ('\\' === DIRECTORY_SEPARATOR) {
|
|
$output->writeln('<error>ERROR: The application that builds Symfony Docs does not support Windows. You can try using a Linux distribution via WSL (Windows Subsystem for Linux).</error>');
|
|
|
|
return 1;
|
|
}
|
|
|
|
$io = new SymfonyStyle($input, $output);
|
|
$io->text('Building all Symfony Docs...');
|
|
|
|
$outputDir = __DIR__.'/output';
|
|
$buildConfig = (new BuildConfig())
|
|
->setSymfonyVersion('7.1')
|
|
->setContentDir(__DIR__.'/..')
|
|
->setOutputDir($outputDir)
|
|
->setImagesDir(__DIR__.'/output/_images')
|
|
->setImagesPublicPrefix('_images')
|
|
->setTheme('rtd')
|
|
;
|
|
|
|
$buildConfig->setExcludedPaths(['.github/', '_build/']);
|
|
|
|
if (!$generateJsonFiles = $input->getOption('generate-fjson-files')) {
|
|
$buildConfig->disableJsonFileGeneration();
|
|
}
|
|
|
|
if ($isCacheDisabled = $input->getOption('disable-cache')) {
|
|
$buildConfig->disableBuildCache();
|
|
}
|
|
|
|
$io->comment(sprintf('cache: %s / output file type(s): %s', $isCacheDisabled ? 'disabled' : 'enabled', $generateJsonFiles ? 'HTML and JSON' : 'HTML'));
|
|
if (!$isCacheDisabled) {
|
|
$io->comment('Tip: add the --disable-cache option to this command to force the re-build of all docs.');
|
|
}
|
|
|
|
$result = (new DocBuilder())->build($buildConfig);
|
|
|
|
if ($result->isSuccessful()) {
|
|
// fix assets URLs to make them absolute (otherwise, they don't work in subdirectories)
|
|
$iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($outputDir));
|
|
|
|
foreach (new RegexIterator($iterator, '/^.+\.html$/i', RegexIterator::GET_MATCH) as $match) {
|
|
$htmlFilePath = array_shift($match);
|
|
$htmlContents = file_get_contents($htmlFilePath);
|
|
|
|
$htmlRelativeFilePath = str_replace($outputDir.'/', '', $htmlFilePath);
|
|
$subdirLevel = substr_count($htmlRelativeFilePath, '/');
|
|
$baseHref = str_repeat('../', $subdirLevel);
|
|
|
|
$htmlContents = str_replace('<head>', '<head><base href="'.$baseHref.'">', $htmlContents);
|
|
$htmlContents = str_replace('<img src="/_images/', '<img src="_images/', $htmlContents);
|
|
file_put_contents($htmlFilePath, $htmlContents);
|
|
}
|
|
|
|
foreach (new RegexIterator($iterator, '/^.+\.css/i', RegexIterator::GET_MATCH) as $match) {
|
|
$htmlFilePath = array_shift($match);
|
|
$htmlContents = file_get_contents($htmlFilePath);
|
|
file_put_contents($htmlFilePath, str_replace('fonts/', '../fonts/', $htmlContents));
|
|
}
|
|
|
|
$io->success(sprintf("The Symfony Docs were successfully built at %s", realpath($outputDir)));
|
|
} else {
|
|
$io->error(sprintf("There were some errors while building the docs:\n\n%s\n", $result->getErrorTrace()));
|
|
$io->newLine();
|
|
$io->comment('Tip: you can add the -v, -vv or -vvv flags to this command to get debug information.');
|
|
|
|
return 1;
|
|
}
|
|
|
|
return 0;
|
|
})
|
|
->getApplication()
|
|
->setDefaultCommand('build-docs', true)
|
|
->run();
|