Skip to content

Commit 36d9b1c

Browse files
committed
added script to generate guides, parallel guide updated
1 parent a4133f8 commit 36d9b1c

38 files changed

+13906
-9
lines changed

RoboFile.php

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,31 @@ public function buildDocs()
128128
$this->changelog();
129129
}
130130

131+
public function buildDocsGuides() {
132+
$guides = Finder::create()
133+
->ignoreVCS(true)
134+
->depth('== 0')
135+
->name('*.md')
136+
->sortByName()
137+
->in('guides');
138+
139+
$guidesLinks = [];
140+
141+
foreach ($guides as $file) {
142+
$name = substr($file->getBasename(), 0, -3);
143+
$title = preg_replace("(\d+-)", '', $name);
144+
$this->_copy($file->getPathname(), 'docs' . DIRECTORY_SEPARATOR . $file->getBasename());
145+
$this->_copy($file->getPathname(), 'docs' . DIRECTORY_SEPARATOR . $title . '.md');
146+
147+
$link = "/docs/$title";
148+
$title = preg_replace('/([A-Z]+)([A-Z][a-z])/', '\\1 \\2', $title);
149+
$title = preg_replace('/([a-z\d])([A-Z])/', '\\1 \\2', $title);
150+
151+
$guidesLinks[] = "<li><a href=\"$link\">$title</a></li>";
152+
}
153+
file_put_contents('_includes/guides.html', implode("\n", $guidesLinks));
154+
}
155+
131156
public function buildDocsModules()
132157
{
133158
$this->taskCleanDir('docs/modules')->run();
@@ -648,8 +673,8 @@ public function processChangelog()
648673
date_format(date_create($release['published_at']),"Y/m/d H:i:s")
649674
);
650675

651-
$changelog .= " / [🦑 Repository](https://github.com/Codeception/$repo) ";
652-
$changelog .= " / [📦 Releases](https://github.com/Codeception/$repo/releases)\n\n";
676+
$changelog .= " / [Repository](https://github.com/Codeception/$repo) ";
677+
$changelog .= " / [Releases](https://github.com/Codeception/$repo/releases)\n\n";
653678

654679
$body = $release['body'];
655680
//user

_includes/guides.html

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,16 @@
1-
<li><a href="/docs/01-Introduction">Introduction</a></li><li><a href="/docs/02-GettingStarted">Getting Started</a></li><li><a href="/docs/03-AcceptanceTests">Acceptance Tests</a></li><li><a href="/docs/04-FunctionalTests">Functional Tests</a></li><li><a href="/docs/05-UnitTests">Unit Tests</a></li><li><a href="/docs/06-ModulesAndHelpers">Modules And Helpers</a></li><li><a href="/docs/06-ReusingTestCode">Reusing Test Code</a></li><li><a href="/docs/07-AdvancedUsage">Advanced Usage</a></li><li><a href="/docs/07-BDD">BDD</a></li><li><a href="/docs/08-Customization">Customization</a></li><li><a href="/docs/09-Data">Data</a></li><li><a href="/docs/10-APITesting">API Testing</a></li><li><a href="/docs/11-Codecoverage">Codecoverage</a></li><li><a href="/docs/12-ContinuousIntegration">Continuous Integration</a></li><li><a href="/docs/12-ParallelExecution">Parallel Execution</a></li>
1+
<li><a href="/docs/Introduction">Introduction</a></li>
2+
<li><a href="/docs/GettingStarted">Getting Started</a></li>
3+
<li><a href="/docs/AcceptanceTests">Acceptance Tests</a></li>
4+
<li><a href="/docs/FunctionalTests">Functional Tests</a></li>
5+
<li><a href="/docs/UnitTests">Unit Tests</a></li>
6+
<li><a href="/docs/ModulesAndHelpers">Modules And Helpers</a></li>
7+
<li><a href="/docs/ReusingTestCode">Reusing Test Code</a></li>
8+
<li><a href="/docs/AdvancedUsage">Advanced Usage</a></li>
9+
<li><a href="/docs/BDD">BDD</a></li>
10+
<li><a href="/docs/Customization">Customization</a></li>
11+
<li><a href="/docs/Data">Data</a></li>
12+
<li><a href="/docs/APITesting">API Testing</a></li>
13+
<li><a href="/docs/Codecoverage">Codecoverage</a></li>
14+
<li><a href="/docs/ContinuousIntegration">Continuous Integration</a></li>
15+
<li><a href="/docs/ParallelExecution">Parallel Execution</a></li>
16+
<li><a href="/docs/Debugging">Debugging</a></li>

_includes/hero.html

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,6 @@ <h1>PHP Testing for <br>everyone<span class="blue">_</span></h1>
2020
</div> <!-- /.row -->
2121
<div>
2222
</div>
23-
<div style="margin-top: 40px; width: 100%;">
24-
{% include cloudways.html %}
25-
</div>
2623
</div>
2724
</div>
2825
</div>

_layouts/doc.html

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,6 @@ <h3>Guides</h3>
3636
<div>
3737

3838

39-
{% include cloudways.html %}
40-
41-
4239
<div id="page">
4340

4441

0 commit comments

Comments
 (0)