Update the stable version docs with Documenter.jl

General Usage
,
1

I want to change the documentation for the current version of my package and I have no code changes to release. Should I create a point release just for this? Or is there some way to edit the stable version of the Documenter.jl docs without making a new release? And if I did that would it be considered bad practice?

1 Like
2

You can tag e.g. v1.2.3+docs (https://github.com/JuliaDocs/Documenter.jl/pull/1298).

7 Likes
3

Ah this is exactly what I was looking for, thank you!

4

Can you use the same approach if you modify README.md?

5

The READMEs, in general, are not built with Documenter at all. Unless you mean the docs generated on JuliaHub when you do not have a docs/make.jl script – in this case, unfortunately, this trick doesn’t work, since JuliaHub will never see these extra +docs tags. You’d have to tag a new patch release.

1 Like