API documentation generation using Jazzy

AliSoftware / OHHTTPStubs

Stub your network requests easily! Test your apps with fake network data and custom response time, response code and headers!

MIT License

5.03k stars 601 forks source link

API documentation generation using Jazzy #244

Open Liquidsoul opened 7 years ago

Liquidsoul commented 7 years ago

New Issue Checklist

[x] I have tried with the latest version of OHHTTPStubs
[x] I have read the README
[x] I have read the Using the right Swift Version of OHHTTPStubs for your project section
[x] I have searched in the existing issues
[x] I have read the OHHTTPStubs wiki to see if there wasn't a detailed page talking about my issue

Issue Description

I am wondering if it would be nice to add jazzy to generate the API documentation.
This would:

expose the code documentation automatically, reducing the workload of maintaining the README and the wiki
add information about API documentation coverage: we could then see if the API is fully documented

AliSoftware commented 7 years ago

I'm not sure there's any point on doing that ourselves while CocoaDocs already does that for us?

http://cocoadocs.org/docsets/OHHTTPStubs/

AliSoftware commented 7 years ago

Note that if you click on the badge in the README it will send you straight to that API documentation on CocoaDocs already. That's pretty standard for README files of most pods :wink:

Liquidsoul commented 7 years ago

Oh right! I did not notice that! Thanks!

Ashton-W commented 7 years ago

CocoaDocs is shutting down at some point iirc

loudmouth commented 7 years ago

CocoaDocs is indeed sunsetting as Ashton-W mentioned. It should be shut down by the end of the month. See the maintainers blog post here.

Liquidsoul commented 7 years ago

Ok so it will be a thing that we will need to address in the near future. I'll let this issue open to remind ourselves of this.