Generate stub documentation #66
Conversation
Sounds good for the moment. We can add to it later once #3 and #4 get implemented.
Looks good to me as is really. Will need some kind of tests if possible, probably create a temp dir, run |
| @@ -8,6 +8,9 @@ Two functions are exported from this module for public use: | |||
| - [`makedocs`](@ref). Generates documentation from docstrings and templated markdown files. | |||
| - [`deploydocs`](@ref). Deploys generated documentation from *Travis-CI* to *GitHub Pages*. | |||
|
|
|||
| Additionally it provides the unexported [`generate`](@ref), which can be used to | |||
There was a problem hiding this comment.
Perhaps [Documenter.generate](@ref) to make it more obvious that it's unexported?
|
|
| """ | ||
| generate( | ||
| pkgname; | ||
| dir = "<package directory>" |
There was a problem hiding this comment.
Should read "<package directory>/docs" ?
Current coverage is 79.76%@@ master #66 diff @@
==========================================
Files 12 13 +1
Lines 804 840 +36
Methods 0 0
Messages 0 0
Branches 0 0
==========================================
- Hits 683 670 -13
- Misses 121 170 +49
Partials 0 0
|
mortenpi
changed the title
| @@ -88,6 +88,16 @@ Formats.Format | |||
| Formats.mimetype | |||
| ``` | |||
|
|
|||
| ## Generator | |||
There was a problem hiding this comment.
Blank line after headers, just to be consistent with the rest of the package.
|
Other than a couple of tiny nitpicks, LGTM. |
| """ | ||
| function index(pkgname) | ||
| """ | ||
| # $(pkgname).jl |
There was a problem hiding this comment.
As with the other comment, blank line after header here too.
generate() creates stub documentation for packages.
|
Fixed the nitpicks. |
|
Great, I'll merge once appveyor finishes. Then later this evening I'll move the package over to JuliaDocs (issue #69) and add you as a co-owner so you can have a bit more freedom to implement what you've got planned. Probably best for neither of us to push direct to |
Addresses #57.
Needs more polish before it can be merged, but thoughts on the exact API would be welcome. Right now I propose a very simple
Documenter.generate(pkgname).Also, no format argument at the moment, just defaulting to mkdocs.