18 Commits

Author SHA1 Message Date
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
Jesse Squires
c19379eeda Release 2.1.0 prep
Summary:
Prepping for `2.1.0`

- [x] Bump version numbers
- [x] Rebase this branch after remaining PRs are closed
- [ ] Run `pod install` (**must be done internally**)
- [x] Re-gen docs
Closes https://github.com/Instagram/IGListKit/pull/380

Reviewed By: rnystrom

Differential Revision: D4381222

Pulled By: jessesquires

fbshipit-source-id: 04646168d3c84d0dd2c08f0a357836b9326f8963
2017-01-04 10:14:37 -08:00
Sherlock
a748e6f6c7 Changed minimum macOS deployment target to 10.10
Summary:
Worth noting that while we support 10.8 and newer, Swift support is only 10.9 and newer. There were only a few more errors for 10.9 deployment target, but I'm not familiar with how it all works.

Using an `available` to disable row actions for users on 10.10 (only available for 10.11 and newer).
Closes https://github.com/Instagram/IGListKit/pull/374

Differential Revision: D4372977

Pulled By: jessesquires

fbshipit-source-id: 19f4b50c8eb4aa92f80241d69c44a367e854f5e8
2016-12-29 11:13:57 -08:00
James Sherlock
5cd771b546 Added Subspec for Diffing
Summary:
So the main Podspec file now has two Subspecs, `Diffing` and for lack of better name `Default`. `Diffing` is purely the files within the common directories (used for Diffing, if in the future we support MacOS NSCollectionView then this may need changing). `Default` depends on `Diffing` but also adds all the non-common files.

To use it via CocoaPods, nothing changes. You `import IGListKit` and you will only have access to the files in the pod you use. (So if you use `IGListKit/Diffing` in your Podfile, then you will only get access to the diffing files). If you do a manual installation, or I assume via Carthage, then you will need to import the correct header file (either `IGListDiffKit.h` or `IGListKit.h` depending on what you want).

Turns out CocoaPods creates it's own umbrella header (unless you tell it otherwise) meaning our ones are unused by it.

Just to confirm `IGListKit` in your Podfile will give you everything, only if you add `/Diffing` will you "opt-out" o
Closes https://github.com/Instagram/IGListKit/pull/368

Differential Revision: D4367438

Pulled By: jessesquires

fbshipit-source-id: 272318ca551e7e8c4177ca3ca501fde23bd9705a
2016-12-27 12:44:27 -08:00
Jesse Squires
9600c23d15 run pod install everywhere, gen docs.
Summary:
- Project fixes for macOS support, #270
- Podspec fixes for macOS, #270
- Project test target fixes
- Pod install all examples
- Re-gen docs

Differential Revision: D4327169

fbshipit-source-id: bbe7896f8f50aaf3b8da03d0c21a0fb6f775c7cd
2016-12-14 14:44:10 -08:00
Ryan Nystrom
b8d2c3bac0 Update docs with 2.0.0 links and copy, regen docs, pod install tests and examples
Summary: Title

Reviewed By: jessesquires

Differential Revision: D4306896

fbshipit-source-id: 134f3afd92d00bed1dee0b99b4f565a606027bdd
2016-12-09 11:44:36 -08:00
Jesse Squires
8bfe2fefdd Final re-gen docs for 2.0
Summary:
Using latest jazzy 0.7.3
Closes https://github.com/Instagram/IGListKit/pull/302

Differential Revision: D4299870

Pulled By: rnystrom

fbshipit-source-id: 4c2f343695d91f2bcb9ca99355e101bfe8817a7a
2016-12-08 10:14:23 -08:00
Ryan Nystrom
e1d6f52552 Fix migration code block formatting
Summary:
Closes #280
Closes https://github.com/Instagram/IGListKit/pull/281

Differential Revision: D4274255

Pulled By: rnystrom

fbshipit-source-id: 4bfbf5afc44a5e534372f449e6f3c0e574e7bfc8
2016-12-04 11:29:02 -08:00
Ryan Nystrom
f2a9d93be8 Add details for 1.0 to 2.0 migration
Summary:
Added migration guide for `IGListDiffable` changes.

Closes #221
Closes https://github.com/Instagram/IGListKit/pull/274

Differential Revision: D4265446

Pulled By: rnystrom

fbshipit-source-id: b98a975a9ef65bca0d46a1011e76834ecf08c681
2016-12-02 06:58:59 -08:00
Jesse Squires
072cff5cfe gen docs for equality guide updates.
Summary: Re-gen docs for equality guide updates.

Reviewed By: rnystrom

Differential Revision: D4251727

fbshipit-source-id: b646c9b5c82a47c5a2734afe96d935de333ee4fd
2016-11-30 18:14:09 -08:00
Jesse Squires
6f879dd34e re-gen docs
Summary: Closes https://github.com/Instagram/IGListKit/pull/264

Differential Revision: D4235666

Pulled By: jessesquires

fbshipit-source-id: 2adb3e5b656d112fe4f2c106721a5d4b9085337a
2016-11-27 16:59:00 -08:00
Jesse Squires
ead9d26a19 Fix links in README, close #256
Summary: Closes https://github.com/Instagram/IGListKit/pull/258

Differential Revision: D4232202

Pulled By: rnystrom

fbshipit-source-id: 947aebcca15fdef7db5def9eb6d0e0b7253624e9
2016-11-24 13:58:58 -08:00
Jesse Squires
8a6fde9e45 Initial setup for guides
Summary:
- Create `Guides/` top-level dir
- Move `README` "creating first list" contents into `Guides/Getting Started.md`
- Add initial `Guides/Migration.md` (ref #221)
- Fix #245

See rendered guides at:

- https://github.com/Instagram/IGListKit/blob/guides-setup/Guides/Getting%20Started.md
- https://github.com/Instagram/IGListKit/blob/guides-setup/Guides/Migration.md
Closes https://github.com/Instagram/IGListKit/pull/252

Differential Revision: D4228332

Pulled By: jessesquires

fbshipit-source-id: f26c2c1ee3cfefb40be1f99674702f95394d4aaf
2016-11-23 12:44:01 -08:00
Jesse Squires
acd3ea217e Cleanup layout
Summary:
Replaces #243

---------------------

- Clean up GridLayout + docs
- Remove GridLayout scroll direction, not used/supported?
- Fix some file target membership issues
- Add GridLayout to umbrella header
- "Sort by name" on xcode project directories
- crtl-I auto format in xcode
- re-gen docs
Closes https://github.com/Instagram/IGListKit/pull/246

Differential Revision: D4219028

Pulled By: jessesquires

fbshipit-source-id: 02d6d284c47dd4301549d9094727054156d596aa
2016-11-21 23:28:58 -08:00
Jesse Squires
cb45684e4d Regen docs for 2.0 release. Close #181
Summary:
Closes #181
Closes https://github.com/Instagram/IGListKit/pull/207

Differential Revision: D4216383

Pulled By: jessesquires

fbshipit-source-id: 664c6d0f1cf82647cf8e2231cf35348b08351c9d
2016-11-21 15:44:01 -08:00
FBShipIt
cdc796746a Initial commit
fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-10-11 10:12:17 -04:00