Commit graph

13 commits

Author SHA1 Message Date
Tim Oliver
894c34db05 Updated the IGListKit docs to v5.2.0 (#1656)
Summary:
## Changes in this pull request

Updates the IGListKit docs to the latest API spec in v5.2.0

### Checklist

- [x] All tests pass. Demo project builds and runs.
- [x] I added tests, an experiment, or detailed why my change isn't tested.
- [x] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes.
- [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/main/.github/CONTRIBUTING.md)

Pull Request resolved: https://github.com/instagram/IGListKit/pull/1656

Reviewed By: jurmarcus

Differential Revision: D93350284

Pulled By: TimOliver

fbshipit-source-id: fa4276caae7309f3ef0fd78f5a0c4bcc05d9cb9f
2026-02-16 23:54:31 -08:00
Tim Oliver
6a521eaf60 Regenerate IGListKit documentation via jazzy
Summary: Regenerated the IGListKit documentation via jazzy.

Reviewed By: fabiomassimo

Differential Revision: D57263196

fbshipit-source-id: 1a649e29a4bfa0d12fa81d00f96ea9264a68f013
2024-05-12 21:14:35 -07:00
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
Zhisheng Huang
05dd3cb71e re-run doc build script
Summary:
As title, currently https://instagram.github.io/IGListKit/ is not working.

Let's try to rebuild the doc

Reviewed By: Ziewvater

Differential Revision: D31811862

fbshipit-source-id: 8a0b0ce6c73542da71dddd13c24b5eb9fe9b0506
2021-10-28 15:49:12 -07:00
Zhisheng Huang
0ccf7fef5d Fix the build_doc.sh and regenerate all the docs! (#1393)
Summary:
## Changes in this pull request

Get this fix and make it ready for 4.0 release.

### Checklist

- [ ] All tests pass. Demo project builds and runs.
- [ ] I added tests, an experiment, or detailed why my change isn't tested.
- [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes.
- [ ] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md)
Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1393

Reviewed By: iperry90

Differential Revision: D18618773

Pulled By: lorixx

fbshipit-source-id: 0360c36d85dc5db15d7e08bdf68ec9c8be992499
2019-11-20 16:23:15 -08:00
Ryan Nystrom
bccef16555 Regenerate docs for 3.4
Summary:
See title
Closes https://github.com/Instagram/IGListKit/pull/1164

Differential Revision: D7838218

Pulled By: rnystrom

fbshipit-source-id: f9e1aa63b5d3a846fc155bd010f6d17e27a1b1ab
2018-05-01 17:04:28 -07:00
Ryan Nystrom
c1894629d7 Generate docs for 3.3.0
Summary:
Ran `build_docs.sh` script for 3.3.0 release
Closes https://github.com/Instagram/IGListKit/pull/1154

Differential Revision: D7728775

Pulled By: rnystrom

fbshipit-source-id: 40a77e95387050a8d7c6bc4a629fdb06b7b0a7fa
2018-04-23 10:01:35 -07:00
Ryan Nystrom
f536e2136d Generate 3.2 docs
Summary:
Does this need to wait for #1086?
Closes https://github.com/Instagram/IGListKit/pull/1085

Differential Revision: D6917735

Pulled By: rnystrom

fbshipit-source-id: 08165c8d9f1215abac1d4bc7c65c1d23e31f758a
2018-02-06 15:47:20 -08:00
Ryan Nystrom
65a5e6de05 Fix binding SC deselection crash and publish 3.1.1
Summary:
- Fixed #918 by checking `respondsToSelector:` (boo optionals)
- Cut 3.1.1 for immediate publish

- [x] All tests pass. Demo project builds and runs.
- [x] I added tests, an experiment, or detailed why my change isn't tested.
- [x] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes.
Closes https://github.com/Instagram/IGListKit/pull/921

Differential Revision: D5748009

Pulled By: rnystrom

fbshipit-source-id: b387b3988abc785f312bc47ac003851283972d7a
2017-08-31 12:51:10 -07:00
Ryan Nystrom
d516867003 Regen documentation for 3.1.0
Summary:
Preparing for 3.1.0 release, regen all documentation

⚠️ wait for #899, #908 to land, rebase, and regen ⚠️
Closes https://github.com/Instagram/IGListKit/pull/907

Differential Revision: D5691928

Pulled By: rnystrom

fbshipit-source-id: 4e8a13c7b25bef2622c4212552a754d0f7d7da62
2017-08-23 14:18:11 -07:00
Jesse Squires
895de471ba Regenerate docs, move docs build script
Summary:
- Move docs script to `scripts/`
- Add small note on README about regenerating docs
- Re-gen docs (doing this because of all the recent spelling, etc. fixes -- note, no breaking changes have landed, so we're good to re-gen.)
Closes https://github.com/Instagram/IGListKit/pull/797

Differential Revision: D5162705

Pulled By: rnystrom

fbshipit-source-id: 83cb0f171c10526a8a4b5d8a746fc2226987f256
2017-05-31 21:01:49 -07:00
Jesse Squires
357a28e5cf final docs update for 3.0
Summary: Closes https://github.com/Instagram/IGListKit/pull/738

Differential Revision: D5052802

Pulled By: jessesquires

fbshipit-source-id: b1ace763da9edbb7bc65ecb9af34aa791e617aa7
2017-05-12 10:46:46 -07:00
Ryan Nystrom
32a566d7c9 Regen docs for 3.0
Summary:
~~Land after #661, #730 and D5031184~~

Rebuild the docs from script. Couple notes:

- Went from 100% to 99%, does that matter? Script output says
  - > 99% documentation coverage with 2 undocumented symbols
  - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment`
- Swift names are different, will that be a problem?

Part of #707

Closes https://github.com/Instagram/IGListKit/pull/728

Differential Revision: D5050951

Pulled By: jessesquires

fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 07:25:00 -07:00