wallytutor / MultiPkgTutorial.jl

Tutorial on how to manage multiple packages inside a single repository

Multi-package repository tutorial

Base development

1. Create root directory src/

2. Inside src/ start julia and create the sub-projects

   (@v1.9) pkg> generate PkgCore
   (@v1.9) pkg> generate PkgOther
   

3. To be able to create dependencies between packages, add them to a local registry. Something as wallytutor-registry can be used to generate a local registry.

4. Under each package directory add the dependencies of other sub-packages. Assuming you are working on PkgOther, you can now add core with:

   (@v1.9) pkg> activate .
   Activating project at `D:\MultiPkgTutorial.jl\src\PkgOther`
   
   (PkgOther) pkg> add PkgCore
   Resolving package versions...

5. After modifications to PkgCore, these must commited to a new version and registry updated.

Documentation

Documentation will be treated as a project itself.

1. Create a docs directory in the root of the repository.
2. Create a Project.toml file with only a [deps] section.
3. Running Julia from within the docs/ directory, activate the project with ] activate . and add the sub-packages as dependencies.
4. After each sub-package update, consider refreshing the local registry then ] update in the documentation project.
5. Create a gh-pages branch of the repository as here.
6. In repository settings configure pages deployment from the newly created branch.