Skip to content

Commit 2474c09

Browse files
authored
Add docfx generator for devices folder (#170)
1 parent c38f541 commit 2474c09

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

src/GenerateDocFxStructure/CommandLineOptions.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ public class CommandlineOptions
3535
/// <summary>
3636
/// Gets or sets the main repository.
3737
/// </summary>
38-
[Option('r', "repo", Required = false, HelpText = "The main repository with the branch to target pointing on the folder used as a source. Default value is 'https://github.com/nanoFramework/nanoFramework.IoT.Device/tree/main/devices'.")]
39-
public string Repo { get; set; } = "https://github.com/nanoFramework/nanoFramework.IoT.Device/tree/main/devices";
38+
[Option('r', "repo", Required = false, HelpText = "The main repository with the branch to target pointing on the folder used as a source. Default value is 'https://github.com/nanoFramework/nanoFramework.IoT.Device/tree/develop/devices'.")]
39+
public string Repo { get; set; } = "https://github.com/nanoFramework/nanoFramework.IoT.Device/tree/develop/devices";
4040

4141
/// <summary>
4242
/// Gets or sets a value indicating whether verbose information is shown in the output.

src/GenerateDocFxStructure/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,18 @@ On top, the links on the internal structure need to be adjusted as well from rel
1212

1313
The tool can be used like this:
1414

15-
`GenerateDocFxStructure -d includesDirectory -m mediaDirectory -s sourceDirectory -r repoUrl`
15+
`GenerateDocFxStructure -d includesDirectory -m mediaDirectory -s sourceDirectory -r repoUrl -i ignore`
1616

1717
- `includesDirectory`: the includes destination directory. ex: `c:\iot-page-docfx\includes`
1818
- `mediaDirectory`: the media destination directory. ex: `c:\iot-page-docfx\media`
1919
- `sourceDirectory`: the source directory. ex: `c:\iot\src\devices`. It is important to point on the devices directory where all the markdown files will be extracted and analyzed.
20-
- `repoUrl`: the repository UR, by default: `https://github.com/dotnet/iot/tree/main/src/devices`
20+
- `repoUrl`: the repository UR, by default: `https://github.com/nanoFramework/nanoFramework.IoT.Device/tree/develop/devices`
21+
- `ignore`: the folder names to ignore, for examples packages, tests and any other that may contain markdown that you don't want to move.
2122

2223
**Important**:
2324

2425
- The links on media will be transformed from `something.jpg` to `~/media/Binding/something.jpg` assuming the previous example with the media directory. Binding is the name of the binding, more precisely the name of the directory containing the Markdown file.
25-
- The links on the repository will be transformed into absolute URL. For example `./sample/program.cs` into `https://github.com/dotnet/iot/tree/main/src/devices/Binding/sample/program.cs` assuming the previous repository and as for the media, Binding is the name of the directory containing the Markdown
26+
- The links on the repository will be transformed into absolute URL. For example `./sample/program.cs` into `https://github.com/nanoFramework/nanoFramework.IoT.Device/tree/develop/devices/Binding/sample/program.cs` assuming the previous repository and as for the media, Binding is the name of the directory containing the Markdown
2627
- If the Markdown is in a series of directories, they will all be replaced the proper way.
2728

2829
The tool can be used with `-v` option to show verbose.

0 commit comments

Comments
 (0)