add foldername kwarg to servedocs #100
Conversation
| @@ -10,9 +10,10 @@ triggered to regenerate the documents, subsequently the LiveServer will render t | |||
| in `docs/build`. | |||
| """ | |||
There was a problem hiding this comment.
Please fix the function signature & add a short note about folder name being the name of the folder if not docs
There was a problem hiding this comment.
My bad, forgot the signatures.
src/utils.jl
Outdated
| @@ -117,9 +118,11 @@ assumed that they are in `docs/src`. | |||
| * `doc_env=false` is a boolean switch to make the server start by activating the doc environment or not (i.e. the `Project.toml` in `docs/`). | |||
| * `skip_dir=""` is a subpath of `docs/` where modifications should not trigger the generation of the docs, this is useful for instance if you're using Weave and Weave generates some files in `docs/src/examples` in which case you should give `skip_dir=joinpath("docs","src","examples")`. | |||
| * `skip_dirs=[]` same as `skip_dir` but for a vector of such dirs. Takes precedence over `skip_dir`. | |||
| * `foldername="docs"` use `foldername` instead of "docs" everywhere. | |||
There was a problem hiding this comment.
(use ... everywhere) --> specify the name of the content folder if different than "docs"`.
Codecov Report
@@ Coverage Diff @@
## master #100 +/- ##
=======================================
Coverage 88.53% 88.53%
=======================================
Files 4 4
Lines 218 218
=======================================
Hits 193 193
Misses 25 25
Continue to review full report at Codecov.
|
|
This looks great, many thanks! Could you please lightly update the docs? ( Then I'll merge and do a minor release with it, thanks! |
|
Thanks Tamás! |
As discussed in #99. For documentation: is the record in the docstrings enough?
For tests I shamelessly copied the testsets and modified them, hope it's fine.