Skip to content

Commit 141d7fa

Browse files
committed
Use forward-slash in <code source=""> attributes
For fixing docfx pages workflow which runs on linux
1 parent 458c81e commit 141d7fa

10 files changed

Lines changed: 67 additions & 111 deletions

File tree

.github/workflows/publish-docs

Lines changed: 0 additions & 44 deletions
This file was deleted.

.github/workflows/publish-docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ jobs:
3838
uses: actions/upload-pages-artifact@v3
3939
with:
4040
# Upload entire repository
41-
path: '<docfx-project-path>/_site'
41+
path: 'docs/_site'
4242
- name: Deploy to GitHub Pages
4343
id: deployment
4444
uses: actions/deploy-pages@v4

src/DotMake.CommandLine.Shared/Attributes/CliArgumentAttribute.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ namespace DotMake.CommandLine
2929
/// <inheritdoc cref="Cli" path="/example/code[@id='gettingStartedDelegate']" />
3030
/// <inheritdoc cref="Cli" path="/example/code[@id='gettingStartedClass']" />
3131
/// <inheritdoc cref="Cli" path="/example/code[@id='gettingStartedClass2']" />
32-
/// <code source="..\TestApp\Commands\ParentCommandAccessorCliCommand.cs" region="ParentCommandAccessorCliCommand" language="cs" />
33-
/// <code source="..\TestApp\Commands\GetCompletionsCliCommand.cs" region="GetCompletionsCliCommand" language="cs" />
32+
/// <code source="../TestApp/Commands/ParentCommandAccessorCliCommand.cs" region="ParentCommandAccessorCliCommand" language="cs" />
33+
/// <code source="../TestApp/Commands/GetCompletionsCliCommand.cs" region="GetCompletionsCliCommand" language="cs" />
3434
/// </example>
3535
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Parameter)]
3636
public class CliArgumentAttribute : Attribute

src/DotMake.CommandLine.Shared/Attributes/CliCommandAttribute.cs

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -65,29 +65,29 @@ namespace DotMake.CommandLine
6565
/// <inheritdoc cref="Cli" path="/example/code[@id='gettingStartedClass']" />
6666
/// <inheritdoc cref="Cli" path="/example/code[@id='gettingStartedClass2']" />
6767
/// <code>
68-
/// <code source="..\TestApp\Commands\RunAsyncCliCommand.cs" region="RunAsyncCliCommand" language="cs" />
69-
/// <code source="..\TestApp\Commands\RunAsyncWithReturnCliCommand.cs" region="RunAsyncWithReturnCliCommand" language="cs" />
68+
/// <code source="../TestApp/Commands/RunAsyncCliCommand.cs" region="RunAsyncCliCommand" language="cs" />
69+
/// <code source="../TestApp/Commands/RunAsyncWithReturnCliCommand.cs" region="RunAsyncWithReturnCliCommand" language="cs" />
7070
/// </code>
71-
/// <code source="..\TestApp\Commands\WriteFileCliCommand.cs" region="WriteFileCliCommand" language="cs" />
72-
/// <code source="..\TestApp\Commands\ArgumentConverterCliCommand.cs" region="ArgumentConverterCliCommand" language="cs" />
73-
/// <code source="..\TestApp\Commands\EnumerableCliCommand.cs" region="EnumerableCliCommand" language="cs" />
74-
/// <code source="..\TestApp\Commands\RootSnakeSlashCliCommand.cs" region="RootSnakeSlashCliCommand" language="cs" />
75-
/// <code source="..\TestApp\Commands\RootWithNestedChildrenCliCommand.cs" region="RootWithNestedChildrenCliCommand" language="cs" />
71+
/// <code source="../TestApp/Commands/WriteFileCliCommand.cs" region="WriteFileCliCommand" language="cs" />
72+
/// <code source="../TestApp/Commands/ArgumentConverterCliCommand.cs" region="ArgumentConverterCliCommand" language="cs" />
73+
/// <code source="../TestApp/Commands/EnumerableCliCommand.cs" region="EnumerableCliCommand" language="cs" />
74+
/// <code source="../TestApp/Commands/RootSnakeSlashCliCommand.cs" region="RootSnakeSlashCliCommand" language="cs" />
75+
/// <code source="../TestApp/Commands/RootWithNestedChildrenCliCommand.cs" region="RootWithNestedChildrenCliCommand" language="cs" />
7676
/// <code>
77-
/// <code source="..\TestApp\Commands\RootWithExternalChildrenCliCommand.cs" region="RootWithExternalChildrenCliCommand" language="cs" />
78-
/// <code source="..\TestApp\Commands\External\ExternalLevel1SubCliCommand.cs" region="ExternalLevel1SubCliCommand" language="cs" />
79-
/// <code source="..\TestApp\Commands\External\ExternalLevel2SubCliCommand.cs" region="ExternalLevel2SubCliCommand" language="cs" />
77+
/// <code source="../TestApp/Commands/RootWithExternalChildrenCliCommand.cs" region="RootWithExternalChildrenCliCommand" language="cs" />
78+
/// <code source="../TestApp/Commands/External\ExternalLevel1SubCliCommand.cs" region="ExternalLevel1SubCliCommand" language="cs" />
79+
/// <code source="../TestApp/Commands/External\ExternalLevel2SubCliCommand.cs" region="ExternalLevel2SubCliCommand" language="cs" />
8080
/// </code>
8181
/// <code>
82-
/// <code source="..\TestApp\Commands\RootAsExternalParentCliCommand.cs" region="RootAsExternalParentCliCommand" language="cs" />
83-
/// <code source="..\TestApp\Commands\External\ExternalLevel1WithParentSubCliCommand.cs" region="ExternalLevel1WithParentSubCliCommand" language="cs" />
84-
/// <code source="..\TestApp\Commands\External\ExternalLevel2WithParentSubCliCommand.cs" region="ExternalLevel2WithParentSubCliCommand" language="cs" />
82+
/// <code source="../TestApp/Commands/RootAsExternalParentCliCommand.cs" region="RootAsExternalParentCliCommand" language="cs" />
83+
/// <code source="../TestApp/Commands/External\ExternalLevel1WithParentSubCliCommand.cs" region="ExternalLevel1WithParentSubCliCommand" language="cs" />
84+
/// <code source="../TestApp/Commands/External\ExternalLevel2WithParentSubCliCommand.cs" region="ExternalLevel2WithParentSubCliCommand" language="cs" />
8585
/// </code>
86-
/// <code source="..\TestApp\Commands\InheritanceCliCommand.cs" region="InheritanceCliCommand" language="cs" />
87-
/// <code source="..\TestApp\Commands\LocalizedCliCommand.cs" region="LocalizedCliCommand" language="cs" />
88-
/// <code source="..\TestApp\Commands\HelpCliCommand.cs" region="HelpCliCommand" language="cs" />
89-
/// <code source="..\TestApp\Commands\ValidationCliCommand.cs" region="ValidationCliCommand" language="cs" />
90-
/// <code source="..\TestApp\Commands\GetCompletionsCliCommand.cs" region="GetCompletionsCliCommand" language="cs" />
86+
/// <code source="../TestApp/Commands/InheritanceCliCommand.cs" region="InheritanceCliCommand" language="cs" />
87+
/// <code source="../TestApp/Commands/LocalizedCliCommand.cs" region="LocalizedCliCommand" language="cs" />
88+
/// <code source="../TestApp/Commands/HelpCliCommand.cs" region="HelpCliCommand" language="cs" />
89+
/// <code source="../TestApp/Commands/ValidationCliCommand.cs" region="ValidationCliCommand" language="cs" />
90+
/// <code source="../TestApp/Commands/GetCompletionsCliCommand.cs" region="GetCompletionsCliCommand" language="cs" />
9191
/// </example>
9292
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
9393
public class CliCommandAttribute : Attribute

src/DotMake.CommandLine.Shared/Attributes/CliDirectiveAttribute.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ namespace DotMake.CommandLine
4545
/// <para>The following directives are built in (can be enabled/disabled via <see cref="CliSettings"/>): <c>[diagram]</c>, <c>[suggest]</c>, <c>[env]</c></para>
4646
/// </summary>
4747
/// <example>
48-
/// <code source="..\TestApp\Commands\DirectiveCliCommand.cs" region="DirectiveCliCommand" language="cs" />
48+
/// <code source="../TestApp/Commands/DirectiveCliCommand.cs" region="DirectiveCliCommand" language="cs" />
4949
/// </example>
5050
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Parameter)]
5151
public class CliDirectiveAttribute : Attribute

src/DotMake.CommandLine.Shared/Attributes/CliOptionAttribute.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,10 @@ namespace DotMake.CommandLine
4343
/// <inheritdoc cref="Cli" path="/example/code[@id='gettingStartedDelegate']" />
4444
/// <inheritdoc cref="Cli" path="/example/code[@id='gettingStartedClass']" />
4545
/// <inheritdoc cref="Cli" path="/example/code[@id='gettingStartedClass2']" />
46-
/// <code source="..\TestApp\Commands\RecursiveOptionCliCommand.cs" region="RecursiveOptionCliCommand" language="cs" />
47-
/// <code source="..\TestApp\Commands\ParentCommandAccessorCliCommand.cs" region="ParentCommandAccessorCliCommand" language="cs" />
48-
/// <code source="..\TestApp\Commands\OptionBundlingCliCommand.cs" region="OptionBundlingCliCommand" language="cs" />
49-
/// <code source="..\TestApp\Commands\GetCompletionsCliCommand.cs" region="GetCompletionsCliCommand" language="cs" />
46+
/// <code source="../TestApp/Commands/RecursiveOptionCliCommand.cs" region="RecursiveOptionCliCommand" language="cs" />
47+
/// <code source="../TestApp/Commands/ParentCommandAccessorCliCommand.cs" region="ParentCommandAccessorCliCommand" language="cs" />
48+
/// <code source="../TestApp/Commands/OptionBundlingCliCommand.cs" region="OptionBundlingCliCommand" language="cs" />
49+
/// <code source="../TestApp/Commands/GetCompletionsCliCommand.cs" region="GetCompletionsCliCommand" language="cs" />
5050
/// </example>
5151
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Parameter)]
5252
public class CliOptionAttribute : Attribute

src/DotMake.CommandLine.Shared/Attributes/CliValidationRules.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public enum CliValidationRules
3939
/// Specifies that argument value(s) must be a legal URI.
4040
/// <para>
4141
/// Valid examples:
42-
/// <code>
42+
/// <code language="none">
4343
/// http://www.google.com
4444
/// ftp://ftp.is.co.za/rfc/rfc1808.txt
4545
/// file:///c:/directory/filename
@@ -52,7 +52,7 @@ public enum CliValidationRules
5252
/// Specifies that argument value(s) must be a legal URL.
5353
/// <para>
5454
/// Valid examples:
55-
/// <code>
55+
/// <code language="none">
5656
/// https://www.google.com
5757
/// http://www.google.com
5858
/// www.google.com

0 commit comments

Comments
 (0)