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

Update Docs generation #374

Merged
merged 9 commits into from Aug 11, 2019
@@ -252,3 +252,4 @@ paket-files/
*.sln.iml
/test/ICSharpCode.SharpZipLib.TestBootstrapper/Properties/launchSettings.json
_testRunner/
docs/help/api/.manifest
@@ -18,10 +18,17 @@ nuget:
disable_publish_on_pr: true
before_build:
- ps: nuget restore ICSharpCode.SharpZipLib.sln
- ps: .\tools\appveyor-docfx-init.ps1
build:
project: ICSharpCode.SharpZipLib.sln
publish_nuget: true
publish_nuget_symbols: true
verbosity: normal
after_build:
- ps: .\tools\appveyor-docfx-build.ps1
test_script:
- ps: tools/appveyor-test.ps1
- ps: tools\appveyor-test.ps1
artifacts:
- path: docs\help\_site
type: zip
name: Documentation
@@ -14,7 +14,10 @@
]
}
],
"dest": "api"
"dest": "api",
"properties": {
"TargetFramework": "NETSTANDARD2"
}
}
],
"build": {
@@ -62,17 +65,22 @@
],
"globalMetadata": {
"_appTitle": "SharpZipLib Help",
"_appFooter": "Copyright © 2000-2017 SharpZipLib Contributors"
"_appFooter": "Copyright © 2000-2019 SharpZipLib Contributors",
"_gitContribute": {
"repo": "https://github.com/icsharpcode/SharpZipLib",
"branch": "master"
}
},
"dest": "_site",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"template": [
"default"
"default",
"template"
],
"postProcessors": [],
"noLangKeyword": false,
"keepFileLink": false,
"cleanupCacheHistory": false
}
}
}
@@ -0,0 +1,34 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" id="SharpZipLib-logo-mono" xmlns="http://www.w3.org/2000/svg" x="0px" y="0px"
width="50px" height="50px" viewBox="-25 -25 306 306">
<g id="sharpzipliblogo">
<circle class="inner-circle" cx="129" cy="128" r="126.5" fill="currentColor"/>
<path d="M210.22,116.121c-1.343-1.2-3.054-2.131-5.086-2.768c-2.038-0.64-4.488-0.964-7.284-0.964h-7.767v36.694h8.249
c2.554,0,4.842-0.354,6.801-1.055c1.959-0.697,3.629-1.72,4.965-3.039c1.338-1.317,2.371-2.918,3.073-4.757
c0.7-1.842,1.052-7.032,1.052-9.421c0-1.81-0.31-8.566-0.994-10.327C212.567,118.784,211.556,117.315,210.22,116.121z" fill="transparent" />
<polygon points="55.21,129.377 69.116,129.377 70.861,112.101 56.957,112.101" fill="transparent" />
<path d="M129.65,1.5C59.788,1.5,3.15,58.137,3.15,128c0,69.864,56.638,126.5,126.5,126.5c69.864,0,126.5-56.636,126.5-126.5
C256.15,58.137,199.515,1.5,129.65,1.5z M147.456,84.857c0.49-1.179,1.15-2.181,2.019-3.069c0.868-0.889,1.872-1.568,3.068-2.077
c1.202-0.507,2.452-0.753,3.824-0.753c1.354,0,2.631,0.253,3.791,0.752c1.18,0.509,2.173,1.188,3.039,2.078
c0.86,0.878,1.539,1.912,2.018,3.069c0.48,1.163,0.724,2.419,0.724,3.733c0,1.331-0.236,2.551-0.724,3.731
c-0.479,1.159-1.157,2.182-2.018,3.04c-0.856,0.859-1.88,1.549-3.038,2.048c-1.158,0.5-2.435,0.753-3.792,0.753
c-1.377,0-2.628-0.247-3.824-0.753c-1.177-0.499-2.209-1.188-3.068-2.048c-0.868-0.866-1.528-1.861-2.018-3.04
c-0.486-1.177-0.722-2.396-0.722-3.731C146.735,87.256,146.972,86.035,147.456,84.857z M219.635,153.356
c-2.676,2.515-6.058,4.5-10.053,5.899c-3.993,1.397-8.692,2.106-13.966,2.106h-5.533v23.281c0,1.104-0.896,2-2,2h-10.927
c-1.104,0-2-0.896-2-2v-23.785h-85.19c-1.104,0-2-0.896-2-2v-7.548c0-0.444,0.147-0.876,0.42-1.227l29.499-37.987H94.457
c-0.038,0.002-0.088,0.004-0.126,0.004H82.66l-1.745,17.276h8.354c1.104,0,2,0.896,2,2v7.016c0,1.104-0.896,2-2,2h-9.497
l-1.866,18.665c-0.103,1.022-0.963,1.801-1.99,1.801h-7.772c-0.566,0-1.105-0.24-1.484-0.66c-0.38-0.42-0.563-0.981-0.505-1.545
l1.879-18.261H54.068l-1.866,18.665c-0.103,1.022-0.963,1.801-1.99,1.801h-7.772c-0.566,0-1.105-0.24-1.484-0.66
c-0.38-0.42-0.563-0.981-0.505-1.545l1.879-18.261h-8.595c-1.104,0-2-0.896-2-2v-7.016c0-1.104,0.896-2,2-2h9.679l1.745-17.276
h-8.233c-1.104,0-2-0.896-2-2v-7.016c0-1.104,0.896-2,2-2h9.317l1.743-17.104c0.104-1.021,0.963-1.797,1.989-1.797h7.778
c0.565,0,1.104,0.24,1.484,0.659c0.379,0.42,0.563,0.981,0.505,1.543l-1.701,16.698h13.904l1.743-17.104
c0.104-1.021,0.963-1.797,1.989-1.797h7.778c0.565,0,1.104,0.24,1.484,0.659c0.379,0.42,0.563,0.981,0.505,1.543l-1.701,16.698
H94.16c0.101,0,0.2,0.007,0.3,0.022h40.805c1.104,0,2,0.896,2,2v6.285c0,0.43-0.139,0.848-0.395,1.193l-28.858,38.847h22.29
c0.069-0.007,0.13-0.01,0.199-0.01h19.184v-37.361h-4.025c-1.104,0-2-0.896-2-2v-6.957c0-1.104,0.896-2,2-2h17.075
c1.104,0,2,0.896,2,2v46.317h10.422v-46.317c0-1.104,0.896-2,2-2h19.062c5.071,0,9.618,0.557,13.515,1.655
c3.895,1.098,7.217,2.729,9.873,4.847c2.657,2.119,4.702,4.761,6.077,7.854c1.355,3.043,2.078,10.276,2.078,14.327
c0,4.604-0.766,11.313-2.047,14.569C224.357,147.811,222.313,150.839,219.635,153.356z" fill="transparent" />

</g>
</svg>
@@ -0,0 +1,20 @@
<nav id="autocollapse" class="navbar navbar-default ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
{{>partials/logo}}
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
@@ -0,0 +1,17 @@
button, a {
color: #516d86;
cursor: pointer;
}

.navbar-default .navbar-nav>.active>a, .navbar-default .navbar-nav>.active>a:focus, .navbar-default .navbar-nav>.active>a:hover {
color: #181c20;
background-color: #c4cdd4;
}

svg:hover path {
fill: currentColor;
}

.navbar-default .navbar-brand:focus, .navbar-default .navbar-brand:hover {
color: #3d4852;
}
@@ -0,0 +1,24 @@
if(-Not $env:APPVEYOR_PULL_REQUEST_TITLE -and $env:CONFIGURATION -eq "Release")
{
pushd docs\help
# & docfx metadata
& docfx docfx.json
if ($lastexitcode -ne 0){
throw [System.Exception] "docfx build failed with exit code $lastexitcode."
}
popd
<#
## Useful for automatically updating gh pages:
git config --global credential.helper store
Add-Content "$env:USERPROFILE\.git-credentials" "https://$($env:access_token):x-oauth-basic@github.com`n"
git config --global user.email $env:op_build_user_email
git config --global user.name $env:op_build_user
git clone https://github.com/ICSharpCode/SharpZipLib.git -b gh-pages origin_site -q
Copy-Item origin_site/.git _site -recurse
CD _site
git add -A 2>&1
git commit -m "CI Updates" -q
git push origin gh-pages -q
#>
}
@@ -0,0 +1,5 @@
if(-Not $env:APPVEYOR_PULL_REQUEST_TITLE -and $env:CONFIGURATION -eq "Release")
{
git checkout $env:APPVEYOR_REPO_BRANCH -q
choco install docfx -y
}
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.