Update API docs #1827
Comments
|
On a side note, I’d love to try and find a way to hook this into the CI process or something. The more things like this we can automate the easier life will be. |
|
Now that I've taken the time to look at a few more repos, it looks to be universal: So yeah, what @mcdappdev says, in spades. |
|
+1 to automatic deployments from CI on every commit on |
|
Currently the API docs are generated locally, then the compiled HTML is pushed to the deploy server. I'd love to update it so that the HTML is generated during the deployment, but I'm not sure it's possible since the generation relies on SourceKitten and Jazzy. I know SourceKitten has been ported to Linux, but I'm not sure if it has all of the required features. Basically, I (or any volunteers) need to spend a couple of hours trying to get the generation script running on Linux. If it indeed works, then we just need to conjure up a Dockerfile that can pull the necessary repos and compile the docs during deployment. We could even get fancy and use GitHub APIs to automatically compile docs for the latest |
|
Ah, I didn't realize it relied on SourceKitten. But yeah if there's a way to get it to run on Linux it should be fairly trivial to implement the rest. Would be super cool to use the new Github stuff for it. |
|
(You could put it on a Mac node on CircleCI or Travis if it’s open source. Guess it depends on being able to hide the secrets
… On 17 Oct 2018, at 21:19, Jimmy McDermott ***@***.***> wrote:
Ah, I didn't realize it relied on SourceKitten. But yeah if there's a way to get it to run on Linux it should be fairly trivial to implement the rest. Would be super cool to use the new Github stuff for it.
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub, or mute the thread.
|
|
Looks like some work are being done to get Jazzy to work on Linux realm/jazzy#495 After that, with the new API and custom docker, it should be fairly simple to get up on Cloud 2 with something automated :) |
|
It looks like you can use Jazzy on Linux since the packages are built with SPM: realm/jazzy#487 (comment) |
Updates manifest.json current as of 2018-10-25 to reflect latest versions of currently listed repos. This is highly imperfect update (more a bit of a stopgap until vapor/vapor#1827 potential solutions can really be addressed), that takes liberties to: (a) add all `currentmajor.minor` versions, at latest `.patch` point (b) adds a `previousmajor` version, at latest `.minor.patch` point, in a few repos where structure hasn't significantly changed (surely a separation of vapor 2 and vapor 3 documentation entirely, or a thorough reworking by somebody way more familiar with all these major structural changes, would be far superior) (c) removes a few seemingly pointless entries (e.g. RC versions, minor versions at outdated `.patch` levels)
|
Closing this, because the docs are automatically regenerated nowadays. |
Looks like the API documentation has not been regenerated since 3.0.2, as the
maxBodySizevalue typo is still present here:https://api.vapor.codes/vapor/latest/Vapor/Structs/NIOServerConfig.html#/s:5Vapor15NIOServerConfigV7defaultACSS8hostname_Si4portSi7backlogSi11workerCountSi11maxBodySizeSb12reuseAddressSb10tcpNoDelaytFZ
The text was updated successfully, but these errors were encountered: