IGListKit/scripts/build_docs.sh
Tim Oliver 9a0f1fd9b2 Regenerate docs via jazzy
Summary:
I regenerated the documentation that lives at https://instagram.github.io/IGListKit/ via the `scripts/build_docs.sh` script.

This updates the IGListKit documentation from 2021 to 2023, updating references to Meta's open source Twitter account, and ensuring the legally required copyright notices are visible.

Differential Revision: D44751773

fbshipit-source-id: 61cc1b9501b1659eb7d4810ea85b80da25e5a69a
2023-04-07 00:23:43 -07:00

31 lines
856 B
Bash
Executable file

#!/bin/bash
# Copyright (c) Meta Platforms, Inc. and affiliates.
#
# This source code is licensed under the MIT license found in the
# LICENSE file in the root directory of this source tree.
if ! which jazzy >/dev/null; then
echo "Jazzy not detected: You can download it from https://github.com/realm/jazzy"
exit
fi
# Docs by jazzy
# https://github.com/realm/jazzy
# ------------------------------
SOURCE=Source
SOURCE_TMP=IGListKit
SOURCEDIR=Source/
jazzy \
--objc \
--clean \
--author 'Instagram' \
--author_url 'https://twitter.com/MetaOpenSource' \
--github_url 'https://github.com/Instagram/IGListKit' \
--sdk iphonesimulator \
--module 'IGListKit' \
--framework-root $SOURCEDIR/ \
--umbrella-header $SOURCEDIR/$SOURCE_TMP/IGListKit.h \
--readme README.md \
--documentation "Guides/*.md" \
--output docs/