Skip to content

Commit

Permalink
build: Fix doc build scripts and update Pod owners
Browse files Browse the repository at this point in the history
  • Loading branch information
Mike Kistler committed Jun 14, 2019
1 parent 2f9e0dd commit bb0866e
Show file tree
Hide file tree
Showing 14 changed files with 27 additions and 42 deletions.
3 changes: 1 addition & 2 deletions IBMWatsonAssistantV1.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ natural-language input and uses machine learning to respond to customers in a wa
DESC
s.homepage = 'https://www.ibm.com/watson/ai-assistant/'
s.license = { :type => 'Apache License, Version 2.0', :file => 'LICENSE' }
s.authors = { 'Anthony Oliveri' => '[email protected]',
'Mike Kistler' => '[email protected]' }
s.authors = { 'Mike Kistler' => '[email protected]' }

s.module_name = 'Assistant'
s.ios.deployment_target = '10.0'
Expand Down
3 changes: 1 addition & 2 deletions IBMWatsonAssistantV2.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ natural-language input and uses machine learning to respond to customers in a wa
DESC
s.homepage = 'https://www.ibm.com/watson/ai-assistant/'
s.license = { :type => 'Apache License, Version 2.0', :file => 'LICENSE' }
s.authors = { 'Anthony Oliveri' => '[email protected]',
'Mike Kistler' => '[email protected]' }
s.authors = { 'Mike Kistler' => '[email protected]' }

s.module_name = 'Assistant'
s.ios.deployment_target = '10.0'
Expand Down
2 changes: 1 addition & 1 deletion IBMWatsonCompareComplyV1.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ IBM Watson™ Compare and Comply analyzes governing documents to provide details
DESC
s.homepage = 'https://www.ibm.com/blogs/watson/2018/02/watson-compare-comply/'
s.license = { :type => 'Apache License, Version 2.0', :file => 'LICENSE' }
s.authors = { 'Anthony Oliveri' => 'oliveri@us.ibm.com' }
s.authors = { 'Mike Kistler' => 'mkistler@us.ibm.com' }

s.module_name = 'CompareComply'
s.ios.deployment_target = '10.0'
Expand Down
3 changes: 1 addition & 2 deletions IBMWatsonDiscoveryV1.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ as well as public and third-party data.
DESC
s.homepage = 'https://www.ibm.com/watson/services/discovery/'
s.license = { :type => 'Apache License, Version 2.0', :file => 'LICENSE' }
s.authors = { 'Anthony Oliveri' => '[email protected]',
'Mike Kistler' => '[email protected]' }
s.authors = { 'Mike Kistler' => '[email protected]' }

s.module_name = 'Discovery'
s.ios.deployment_target = '10.0'
Expand Down
3 changes: 1 addition & 2 deletions IBMWatsonLanguageTranslatorV3.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ IBM Watson™ Language Translator can identify the language of text and translat
DESC
s.homepage = 'https://www.ibm.com/watson/services/language-translator/'
s.license = { :type => 'Apache License, Version 2.0', :file => 'LICENSE' }
s.authors = { 'Anthony Oliveri' => '[email protected]',
'Mike Kistler' => '[email protected]' }
s.authors = { 'Mike Kistler' => '[email protected]' }

s.module_name = 'LanguageTranslator'
s.ios.deployment_target = '10.0'
Expand Down
3 changes: 1 addition & 2 deletions IBMWatsonNaturalLanguageClassifierV1.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ return information for texts that it is not trained on.
DESC
s.homepage = 'https://www.ibm.com/watson/services/natural-language-classifier/'
s.license = { :type => 'Apache License, Version 2.0', :file => 'LICENSE' }
s.authors = { 'Anthony Oliveri' => '[email protected]',
'Mike Kistler' => '[email protected]' }
s.authors = { 'Mike Kistler' => '[email protected]' }

s.module_name = 'NaturalLanguageClassifier'
s.ios.deployment_target = '10.0'
Expand Down
3 changes: 1 addition & 2 deletions IBMWatsonNaturalLanguageUnderstandingV1.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ including categories, concepts, emotion, entities, keywords, metadata, relations
DESC
s.homepage = 'https://www.ibm.com/watson/services/natural-language-understanding/'
s.license = { :type => 'Apache License, Version 2.0', :file => 'LICENSE' }
s.authors = { 'Anthony Oliveri' => '[email protected]',
'Mike Kistler' => '[email protected]' }
s.authors = { 'Mike Kistler' => '[email protected]' }

s.module_name = 'NaturalLanguageUnderstanding'
s.ios.deployment_target = '10.0'
Expand Down
3 changes: 1 addition & 2 deletions IBMWatsonPersonalityInsightsV3.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ from digital communications such as email, text messages, tweets, and forum post
DESC
s.homepage = 'https://www.ibm.com/watson/services/personality-insights/'
s.license = { :type => 'Apache License, Version 2.0', :file => 'LICENSE' }
s.authors = { 'Anthony Oliveri' => '[email protected]',
'Mike Kistler' => '[email protected]' }
s.authors = { 'Mike Kistler' => '[email protected]' }

s.module_name = 'PersonalityInsights'
s.ios.deployment_target = '10.0'
Expand Down
3 changes: 1 addition & 2 deletions IBMWatsonSpeechToTextV1.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ of the audio signal. It continuously returns and retroactively updates a transcr
DESC
s.homepage = 'https://www.ibm.com/watson/services/speech-to-text/'
s.license = { :type => 'Apache License, Version 2.0', :file => 'LICENSE' }
s.authors = { 'Anthony Oliveri' => '[email protected]',
'Mike Kistler' => '[email protected]' }
s.authors = { 'Mike Kistler' => '[email protected]' }

s.module_name = 'SpeechToText'
s.ios.deployment_target = '10.0'
Expand Down
3 changes: 1 addition & 2 deletions IBMWatsonTextToSpeechV1.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ The service streams the results back to the client with minimal delay.
DESC
s.homepage = 'https://www.ibm.com/watson/services/text-to-speech/'
s.license = { :type => 'Apache License, Version 2.0', :file => 'LICENSE' }
s.authors = { 'Anthony Oliveri' => '[email protected]',
'Mike Kistler' => '[email protected]' }
s.authors = { 'Mike Kistler' => '[email protected]' }

s.module_name = 'TextToSpeech'
s.ios.deployment_target = '10.0'
Expand Down
3 changes: 1 addition & 2 deletions IBMWatsonToneAnalyzerV3.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ The service can analyze tone at both the document and sentence levels.
DESC
s.homepage = 'https://www.ibm.com/watson/services/tone-analyzer/'
s.license = { :type => 'Apache License, Version 2.0', :file => 'LICENSE' }
s.authors = { 'Anthony Oliveri' => '[email protected]',
'Mike Kistler' => '[email protected]' }
s.authors = { 'Mike Kistler' => '[email protected]' }

s.module_name = 'ToneAnalyzer'
s.ios.deployment_target = '10.0'
Expand Down
3 changes: 1 addition & 2 deletions IBMWatsonVisualRecognitionV3.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ scenes, objects, faces, and other content. The response includes keywords that p
DESC
s.homepage = 'https://www.ibm.com/watson/services/visual-recognition/'
s.license = { :type => 'Apache License, Version 2.0', :file => 'LICENSE' }
s.authors = { 'Anthony Oliveri' => '[email protected]',
'Mike Kistler' => '[email protected]' }
s.authors = { 'Mike Kistler' => '[email protected]' }

s.module_name = 'VisualRecognition'
s.ios.deployment_target = '10.0'
Expand Down
10 changes: 2 additions & 8 deletions Scripts/generate-documentation.sh
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,7 @@ cd ..
# Create folder for generated documentation
################################################################################

if [ -d "${outdir}" ]; then
echo "The output directory ${outdir} already exists."
echo "Please remove the directory and try again."
exit
fi

mkdir ${outdir}
mkdir ${outdir}/services
mkdir -p ${outdir}/services

################################################################################
# Run Jazzy to generate documentation
Expand All @@ -60,6 +53,7 @@ for service in ${services[@]}; do
--readme Source/${service}/README.md \
--documentation README.md \
--github_url https://github.com/watson-developer-cloud/swift-sdk \
--copyright "© IBM Corp. 2016-$(date +%Y). (Last updated: $(date +%Y-%m-%d))" \
--hide-documentation-coverage
done

Expand Down
24 changes: 13 additions & 11 deletions Scripts/travis/publish-documentation.sh
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,17 @@ git fetch
git checkout master
latestVersion=$(git describe --abbrev=0 --tags)

git clone --quiet --branch=gh-pages [email protected]:watson-developer-cloud/swift-sdk.git gh-pages > /dev/null

# Delete all the old docs (but not the docs directory -- this is hand written)
(cd gh-pages && git rm -rf css img index.html js services undocumented.json)

# Generate the API docs
./Scripts/generate-documentation.sh

# Push newly-generated docs to the gh-pages branch
git checkout --track origin/gh-pages
# Delete old docs
rm -rf css img js services
cp -r gh-pages/* .
rm -rf gh-pages/
git add .
git commit -m "SDK docs for release ${latestVersion}"
git push --set-upstream origin gh-pages
./Scripts/generate-documentation.sh gh-pages

# Commit and push the newly generated API docs
pushd gh-pages
git add .
git commit -m "SDK docs for release ${latestVersion}"
git push
popd

0 comments on commit bb0866e

Please sign in to comment.