Skip to content
This repository has been archived by the owner on Sep 20, 2023. It is now read-only.

Pin docfx version #246

Merged
merged 4 commits into from
Feb 20, 2020
Merged
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
22 changes: 6 additions & 16 deletions .ci/azure-pipelines.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ trigger:

jobs:
- job: docs_build
displayName: Docs Build
displayName: "Main Build"
pool:
vmImage: windows-latest
steps:
Expand All @@ -18,7 +18,7 @@ jobs:
persistCredentials: true

- task: CmdLine@2
displayName: "Update submodules"
displayName: "Update Submodules"
inputs:
script: 'git submodule update --recursive --remote'
workingDirectory: '$(Build.SourcesDirectory)'
Expand All @@ -32,36 +32,26 @@ jobs:

- task: ArchiveFiles@2
condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'), in(variables['Build.Reason'], 'IndividualCI', 'BatchedCI', 'BuildCompletion'))
displayName: "Package Documentation Website"
displayName: "Package Documentation"
inputs:
rootFolderOrFile: '$(Build.SourcesDirectory)/_site'
includeRootFolder: false
archiveType: 'tar' # Options: zip, 7z, tar, wim
tarCompression: 'gz' # Optional. Options: gz, bz2, xz, none
archiveType: 'tar'
tarCompression: 'gz'
archiveFile: '$(Build.ArtifactStagingDirectory)/docs-$(Build.BuildId).tar.gz'
replaceExistingArchive: true
#verbose: # Optional
#quiet: # Optional

- task: GitHubRelease@0
condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'), in(variables['Build.Reason'], 'IndividualCI', 'BatchedCI', 'BuildCompletion'))
displayName: "Create GitHub release"
displayName: "Create GitHub Release"
inputs:
gitHubConnection: Jellyfin Release Download
repositoryName: '$(Build.Repository.Name)'
action: 'create' # Options: create, edit, delete
target: '$(Build.SourceVersion)' # Required when action == Create || Action == Edit
tagSource: 'manual' # Required when action == Create# Options: auto, manual
#tagPattern: # Optional
tag: 'ci/$(Build.BuildId)' # Required when action == Edit || Action == Delete || TagSource == Manual
title: 'CI Documentation Build $(Build.BuildId)' # Optional
#releaseNotesSource: 'file' # Optional. Options: file, input
#releaseNotesFile: # Optional
#releaseNotes: # Optional
assets: '$(Build.ArtifactStagingDirectory)/docs-$(Build.BuildId).tar.gz' # Optional
#assetUploadMode: 'delete' # Optional. Options: delete, replace
#isDraft: false # Optional
#isPreRelease: false # Optional
addChangeLog: true # Optional
compareWith: 'lastFullRelease' # Required when addChangeLog == True. Options: lastFullRelease, lastRelease, lastReleaseByTag
#releaseTag: # Required when compareWith == LastReleaseByTag
4 changes: 2 additions & 2 deletions .ci/build-in-ci.ps1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
choco install docfx -y
choco install docfx -y --version 2.48.1
docfx docfx.json
if ($lastexitcode -ne 0){
throw ("Error generating document")
}
}
2 changes: 1 addition & 1 deletion .ci/publish-to-gh-pages.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/bash

# Download the latest release.
# Download the latest release
curl -s https://api.github.com/repos/jellyfin/jellyfin-docs/releases/latest | grep "browser_download_url.*docs-.*\.tar\.gz" | cut -d : -f 2,3 | tr -d \" | wget -O /tmp/docs.tar.gz -qi -

# Clean any old files
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,14 @@ This repository houses all documentation for Jellyfin available at [jellyfin.org

# Layout

This repository is built using [DocFX](https://dotnet.github.io/docfx/) using [DocFX Flavored Markdown](https://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html), for bit of a tutorial on writing, [see the Content section here](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html).
This repository is built using [DocFX](https://dotnet.github.io/docfx/) and [DocFX Flavored Markdown](https://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html). See the content section [here](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html) for a quick tutorial.

## Plugin API

Describe all available API surfaces and class from plugin development.

## ApiSpec

`apispec` is used to overwrite specific plugin API page contexts.

## Docs
Expand Down