Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation github action, Fix links in release note generator #146

Open
wants to merge 22 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Documentation
on:
pull_request:
release:
types: [created]

jobs:
Documentation:
runs-on: windows-latest
steps:
- uses: actions/checkout@v2
- name: Setup MSBuild
uses: microsoft/[email protected]
- name: Build SDK
run: |
dotnet build dropbox-sdk-dotnet/Dropbox.Api
- name: Build Documentation
run: |
dotnet restore doc/StoneDocs.shfbproj
msbuild doc/StoneDocs.shfbproj # WinForms refuse to work with .NET 5.0
tar -czf doc/Help.tar.gz -C doc/Help .
- name: Upload Documentation
uses: actions/upload-artifact@v2
with:
name: documentation.tar.gz
path: doc/Help.tar.gz
retention-days: 1
- name: Get Release Information
id: get_release
uses: bruceadams/[email protected]
if: github.event_name == 'release'
env:
GITHUB_TOKEN: ${{ github.token }}
- name: Attach Documentation to Relase
uses: actions/[email protected]
if: github.event_name == 'release'
env:
GITHUB_TOKEN: ${{ github.token }}
with:
upload_url: ${{ steps.get_release.outputs.upload_url }}
asset_path: doc/Help.tar.gz
asset_name: documentation.tar.gz
asset_content_type: application/gzip
- name: Push Documentation
uses: JamesIves/github-pages-deploy-action@releases/v3
if: github.event_name == 'release'
with:
ACCESS_TOKEN: ${{ secrets.GH_PAGES_PUBLISH_TOKEN }}
BRANCH: gh-pages # The branch the action should deploy to.
FOLDER: doc/Help # The folder the action should deploy.
50 changes: 35 additions & 15 deletions doc/StoneDocs.shfbproj
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@
<RootNamespace>Documentation</RootNamespace>
<Name>StoneDocs</Name>
<!-- SHFB properties -->
<FrameworkVersion>.NET Framework 4.5</FrameworkVersion>
<OutputPath>.\Help\</OutputPath>
<FrameworkVersion>Cross-platform (.NET Core/.NET Standard)</FrameworkVersion>
<OutputPath>./Help/</OutputPath>
<HtmlHelpName>DotNetApiDocumentation</HtmlHelpName>
<Language>en-US</Language>
<DocumentationSources>
<DocumentationSource sourceFile="..\dropbox-sdk-dotnet\Dropbox.Api\stone_summaries.xml" />
<DocumentationSource sourceFile="..\dropbox-sdk-dotnet\Dropbox.Api\bin\Release\net45\Dropbox.Api.dll" />
<DocumentationSource sourceFile="..\dropbox-sdk-dotnet\Dropbox.Api\bin\Release\net45\Dropbox.Api.XML" />
<DocumentationSource sourceFile="..\dropbox-sdk-dotnet\Dropbox.Api\Generated\namespace_summaries.xml" /></DocumentationSources>
<DocumentationSource sourceFile="../dropbox-sdk-dotnet/Dropbox.Api/Dropbox.Api.csproj" />
<DocumentationSource sourceFile="../dropbox-sdk-dotnet/Dropbox.Api/stone_summaries.xml" />
<DocumentationSource sourceFile="../dropbox-sdk-dotnet/Dropbox.Api/Generated/namespace_summaries.xml" />
</DocumentationSources>
<BuildAssemblerVerbosity>OnlyWarningsAndErrors</BuildAssemblerVerbosity>
<HelpFileFormat>Website</HelpFileFormat>
<IndentHtml>False</IndentHtml>
Expand Down Expand Up @@ -55,10 +55,12 @@
</TransformComponentArguments>
<ComponentConfigurations>
</ComponentConfigurations>
<PostBuildEvent>rmdir Help\toc /S /Q
rmdir Help\fti /S /Q
del Help\Search* /Q
del Help\Web* /Q</PostBuildEvent>
<PostBuildEvent>
rm -rf Help/toc
rm -rf Help/fti
rm -f Help/Search*
rm -f Help/Web*
</PostBuildEvent>
<RunPostBuildEvent>OnBuildSuccess</RunPostBuildEvent>
</PropertyGroup>
<!-- There are no properties for these groups. AnyCPU needs to appear in order for Visual Studio to perform
Expand All @@ -84,12 +86,30 @@ del Help\Web* /Q</PostBuildEvent>
<Folder Include="styles" />
</ItemGroup>
<ItemGroup>
<Content Include="icons\blue_dropbox_glyph.png">
<Content Include="icons/blue_dropbox_glyph.png">
<ImageId>blue_dropbox_glyph</ImageId>
<AlternateText>blue dropbox glyph</AlternateText>
</Content>
<Content Include="styles\branding-Website.css" />
<Content Include="styles/branding-Website.css" />
</ItemGroup>
<!-- Import the SHFB build targets -->
<Import Project="$(SHFBROOT)\SandcastleHelpFileBuilder.targets" />
</Project>

<!-- See https://ewsoftware.github.io/SHFB/html/50ad2c8c-5004-4b4c-a77f-97b8c403c9f2.htm -->
<!-- Import the common properties to support NuGet restore -->
<Import Project="$(MSBuildExtensionsPath)/$(MSBuildToolsVersion)/Microsoft.Common.props"
Condition="Exists('$(MSBuildExtensionsPath)/$(MSBuildToolsVersion)/Microsoft.Common.props')" />

<ItemGroup>
<PackageReference Include="EWSoftware.SHFB" Version="2020.3.6" />
<PackageReference Include="EWSoftware.SHFB.NETFramework" Version="4.8.0" />
</ItemGroup>

<!-- Import the common build targets during NuGet restore because before the
packages are being installed, $(SHFBROOT) is not set yet -->
<Import Project="$(MSBuildToolsPath)/Microsoft.Common.targets"
Condition="'$(MSBuildRestoreSessionId)' != ''"/>

<!-- Import the SHFB build targets during build -->
<Import Project="$(SHFBROOT)/SandcastleHelpFileBuilder.targets"
Condition="'$(MSBuildRestoreSessionId)' == ''"/>

</Project>
37 changes: 0 additions & 37 deletions generate.py

This file was deleted.