Skip to content

Commit 38e6a4c

Browse files
committed
copy page_header.html for documentation
1 parent e86bd2a commit 38e6a4c

File tree

5 files changed

+47
-3
lines changed

5 files changed

+47
-3
lines changed

src/CodeGeneration/DocGenerator/Documentation/Files/RawDocumentationFile.cs renamed to src/CodeGeneration/DocGenerator/Documentation/Files/AsciiDocDocumentationFile.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66

77
namespace DocGenerator.Documentation.Files
88
{
9-
public class RawDocumentationFile : DocumentationFile
9+
public class AsciiDocDocumentationFile : DocumentationFile
1010
{
11-
public RawDocumentationFile(FileInfo fileLocation) : base(fileLocation) { }
11+
public AsciiDocDocumentationFile(FileInfo fileLocation) : base(fileLocation) { }
1212

1313
public override Task SaveToDocumentationFolderAsync()
1414
{

src/CodeGeneration/DocGenerator/Documentation/Files/DocumentationFile.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ public static DocumentationFile Load(FileInfo fileLocation)
2727
case ".png":
2828
return new ImageDocumentationFile(fileLocation);
2929
case ".asciidoc":
30-
return new RawDocumentationFile(fileLocation);
30+
return new AsciiDocDocumentationFile(fileLocation);
31+
case ".html":
32+
return new HtmlDocumentationFile(fileLocation);
3133
default:
3234
throw new ArgumentOutOfRangeException(nameof(fileLocation),
3335
$"The extension you specified is currently not supported: {extension}");
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
using System.IO;
2+
using System.Text.RegularExpressions;
3+
using System.Threading.Tasks;
4+
5+
namespace DocGenerator.Documentation.Files {
6+
public class HtmlDocumentationFile : DocumentationFile
7+
{
8+
public HtmlDocumentationFile(FileInfo fileLocation) : base(fileLocation) { }
9+
10+
public override async Task SaveToDocumentationFolderAsync()
11+
{
12+
var docFileName = CreateDocumentationLocation();
13+
14+
var copyRelativeTask = CopyFileAsync(FileLocation.FullName, docFileName.FullName);
15+
await copyRelativeTask;
16+
}
17+
18+
protected override FileInfo CreateDocumentationLocation()
19+
{
20+
var testFullPath = FileLocation.FullName;
21+
22+
var p = "\\" + Path.DirectorySeparatorChar.ToString();
23+
var testInDocumenationFolder = Regex.Replace(testFullPath, $@"(^.+{p}Tests{p}|\" + Extension + "$)", "")
24+
.PascalToHyphen() + Extension;
25+
26+
var documentationTargetPath = Path.GetFullPath(Path.Combine(Program.OutputDirPath, testInDocumenationFolder));
27+
28+
var fileInfo = new FileInfo(documentationTargetPath);
29+
if (fileInfo.Directory != null)
30+
Directory.CreateDirectory(fileInfo.Directory.FullName);
31+
return fileInfo;
32+
}
33+
}
34+
}

src/CodeGeneration/DocGenerator/LitUp.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,9 @@ public static IEnumerable<IEnumerable<DocumentationFile>> GetDocumentFiles(Dicti
4444
// process asciidocs last as they may have generated
4545
// includes to other output asciidocs
4646
yield return InputFiles("*.asciidoc");
47+
48+
// deprecation notice for old version
49+
yield return InputFiles("page_header.html");
4750
}
4851

4952
public static async Task GoAsync(string[] args)

src/Tests/Tests/page_header.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<p>
2+
<strong>NOTE</strong>: You are looking at documentation for an older release.
3+
For the latest information, see the
4+
<a href="../current/index.html">current release documentation</a>.
5+
</p>

0 commit comments

Comments
 (0)