Skip to content

Commit

Permalink
Temporarily disabled API docs
Browse files Browse the repository at this point in the history
It is causing pdf generation to fail. See dotnet/docfx#4488 (comment)
  • Loading branch information
atruskie committed Feb 16, 2021
1 parent 985e108 commit e448dbc
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 4 deletions.
2 changes: 1 addition & 1 deletion build/generate_docs.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ try {


log "Building docs" "Build docs"
exec { docfx build --log verbose }
exec { docfx build --log verbose --force }

log "✅ Doc generation success"
}
Expand Down
2 changes: 1 addition & 1 deletion build/publish_docs.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ try {
Write-Output "Deploying to netlify"

$prod_arg = if ($prod) { "--prod" } else { "" }
Write-Output "prod moode is $prod"
Write-Output "prod mode is $prod"

# NETLIFY_AUTH_TOKEN used by this command
exec { netlify deploy --dir=. --message="Docs deploy for https://github.com/QutEcoacoustics/audio-analysis/commit/$commit_hash" $prod_arg --site="078c0d59-a45a-4458-bd92-2d7c05f44bb6" --json } | Write-Output -OutVariable "deploy_result"
Expand Down
2 changes: 1 addition & 1 deletion docs/metadata_filter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ ApiRules:
uidRegex: .*
type: Type
- exclude:
uidRegex: ^System\..*
uidRegex: ^System.*
type: Namespace
10 changes: 9 additions & 1 deletion docs/pdf/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,12 @@
- name: Guides
href: ../guides/toc.yml
- name: Technical
href: ../technical/toc.yml
items:
- name: Changelog
href: ../../CHANGELOG.md
- name: Contributing
href: ../../CONTRIBUTING.md
- name: Commands
href: ../technical/commands/toc.yml
- name: Config files
href: ../technical/configs/toc.yml

0 comments on commit e448dbc

Please sign in to comment.