See below, I forgot
I don’t understand what’s happening hen I use
Documenter.makedocs() to create documentation for my package. I’ve performed the following steps:
- Initialize a template for document generation with
cd MY_PKG (...) pkg> activate . julia> using DocumenterTools julia> DocumenterTools.generate()
- Add some doc comments to the source of the module
- Add an additional starter example file, e.g.,
docs/sourcecontaining something like
```@autodocs Modules = [MY_PKG] ```
using Documenter using CryptoEnigma makedocs( sitename = "MY_PKG Documentation", format = Documenter.HTML(prettyurls = false), modules = [MY_PKG], pages = [ "Index" => "index.md", "An other page" => "other.md", ] )
- Make documentation by running
cd MY_PKG (...) pkg> activate . julia> include("docs/make.jl")
This creates the expected documentation with links to source in the correct places.
But if I change my code to add some new doc comments, and again run
include("docs/make.jl"), the changes are not reflected in the documentation. At first I thought this was because (is this true?)
makedocs is looking at committed changes only. So I committed them and got the same result: unchanged documentation. Then I thought that perhaps the changes need to be pushed, so I did that too, but still got the same documentation — except then the links went to the wrong places in the committed and pushed source files (since those did reflect the additional doc comments).
What’s going on here? How do I get my generated documentation to track changes to my code. I must be missing a step in the workflow somewhere.