tpapp / PkgSkeleton.jl

Generate Julia package skeletons using a simple template system
Other
50 stars 7 forks source link

Setup (instantiate) the docs project from the beginning #11

Closed ffevotte closed 5 years ago

ffevotte commented 5 years ago

In the current version of PkgSkeleton.jl, the user is expected to setup the documentation sub-project by running the following commands in the test subdirectory (more or less taken from the "test documentation (instantiation)" part of the test suite):

using Pkg
Pkg.activate(".")
Pkg.add("Documenter")
Pkg.develop(PackageSpec(path=joinpath("..")))

Only then is it possible to start generating the documentation.

The following PR does this during the package generation phase. It also puts these commands in a docs/setup.jl file, so that another user only has to clone the repository of the generated package and run the docs/setup.jl script before they can start generating the documentation.

codecov[bot] commented 5 years ago

Codecov Report

Merging #11 into master will not change coverage. The diff coverage is 100%.

Impacted file tree graph

@@          Coverage Diff          @@
##           master    #11   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files           1      1           
  Lines          46     46           
=====================================
  Hits           46     46
Impacted Files Coverage Δ
src/PkgSkeleton.jl 100% <100%> (ø) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update ffb2e84...2cb4c73. Read the comment docs.

tpapp commented 5 years ago

Thanks. I think that making the script call develop is indeed useful.

Can you explain the purpose of leaving setup.jl around? My understanding is that once the Manifest.toml is there, one can just instantiate.

ffevotte commented 5 years ago

You're right: the setup.jl script is only useful if one does not commit the Manifest.toml. Which they probably should, so that the file can safely removed from the generated project.

tpapp commented 5 years ago

Closing in favor of #14.