Skip to content

Publishing Jazzy Docs to GitHub.io

Travis Prescott edited this page Jun 21, 2022 · 14 revisions
  1. Ensure that all Jazzy configurations in jazzy/*.yml are updated with the current SDK version.
  2. Install the latest version of Jazzy with gem install jazzy and your pod repo is up-to-date with pod repo update trunk.
  3. Ensure you are at the root directory of the azure-sdk-for-ios repo.
  4. Ensure you are on the main branch. Run pod install to ensure the Pods project is up-to-date. For external repos, the script will install your Podfile after is clones the repo.
  5. Clear any cached data with: rm -rf build/
  6. Run python eng/scripts/build_api_docs.py <library name> <library name> ... to generate Jazzy docs for all the libraries that are published. This step also generates a new index.html page which has a link to ONLY the libraries you just generated. So if you only generated updated docs for one existing library, DO NOT replace the index.html page in step 9.
  7. Run git checkout gh-pages to check out the gh-pages branch.
  8. Run rm -rf Azure* to delete all top-level documentation directories. This ensures that we delete the docs for types that have been removed since the last publish.
  9. Run mv build/jazzy/* . to move all the new docs and the new index.html page into the root of the repo.
  10. Run git add <library name> <library name> ... to stage all the new docs. If you are updating the index.html page, also add that with git add index.html.
  11. Run git commit --amend --no-edit to amend the ONE AND ONLY docs commit in the gh-pages branch. Do NOT add a new commit. This prevents the repo size from growing significantly due to storing all old revisions of the docs site.
  12. Run git push upstream gh-pages --force to push the new docs. The docs site will automatically be rebuilt and should be live within a minute or so.