Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove symlink between latest and devurl. #1151

Merged
merged 1 commit into from
Oct 8, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

* ![Enhancement][badge-enhancement] In the PDF/LaTeX output, images that are wider than the text are now being scaled down to text width automatically. The PDF builds now require the [adjustbox](https://ctan.org/pkg/adjustbox) LaTeX package to be available. ([#1137][github-1137])

* ![BREAKING][badge-breaking] Documenter no longer creates a symlink between the old `latest` url to specified `devurl`. Make sure to update links in e.g. the package readme. ([#1151][github-1151])

## Version `v0.23.3`

* ![Bugfix][badge-bugfix] Fix file permission error when `Pkg.test`ing Documenter. ([#1115][github-1115])
Expand Down Expand Up @@ -415,6 +417,7 @@
[github-1115]: https://github.com/JuliaDocs/Documenter.jl/pull/1115
[github-1137]: https://github.com/JuliaDocs/Documenter.jl/pull/1137
[github-1147]: https://github.com/JuliaDocs/Documenter.jl/pull/1147
[github-1151]: https://github.com/JuliaDocs/Documenter.jl/pull/1151

[documenterlatex]: https://github.com/JuliaDocs/DocumenterLaTeX.jl
[documentermarkdown]: https://github.com/JuliaDocs/DocumenterMarkdown.jl
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Usage questions can be posted on the [Julia Discourse forum][discourse-tag-url]

Contributions are very welcome, as are feature requests and suggestions. Please open an [issue][issues-url] if you encounter any problems. The [contributing page][contrib-url] has a few guidelines that should be followed when opening pull requests and contributing code.

[contrib-url]: https://juliadocs.github.io/Documenter.jl/latest/man/contributing/
[contrib-url]: https://juliadocs.github.io/Documenter.jl/dev/contributing/
[discourse-tag-url]: https://discourse.julialang.org/tags/documenter
[gitter-url]: https://gitter.im/juliadocs/users

Expand Down
6 changes: 3 additions & 3 deletions docs/src/man/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,6 @@ Some projects or organizations maintain dedicated documentation repositories tha
separate from specific packages.

- [DifferentialEquations.jl](http://docs.juliadiffeq.org/latest/)
- [JuliaDocs landing page](https://juliadocs.github.io/latest/)
- [JuliaMusic](https://juliamusic.github.io/JuliaMusic_documentation.jl/latest/)
- [Plots.jl](https://docs.juliaplots.org/latest/)
- [JuliaDocs landing page](https://juliadocs.github.io/dev/)
- [JuliaMusic](https://juliamusic.github.io/JuliaMusic_documentation.jl/dev/)
- [Plots.jl](https://docs.juliaplots.org/dev/)
8 changes: 0 additions & 8 deletions src/Documenter.jl
Original file line number Diff line number Diff line change
Expand Up @@ -545,14 +545,6 @@ function git_push(
devurl_dir = joinpath(dirname, devurl)
gitrm_copy(target_dir, devurl_dir)
Writers.HTMLWriter.generate_siteinfo_file(devurl_dir, devurl)
# symlink "latest" to devurl to preserve links (remove in some future release)
if devurl != "latest"
rm(joinpath(dirname, "latest"); recursive = true, force = true)
@warn(string("creating symlink from `latest` to `$(devurl)` for backwards ",
"compatibility with old links. In future Documenter versions this symlink ",
"will not be created. Please update any links that point to `latest`."))
cd(dirname) do; rm_and_add_symlink(devurl, "latest"); end
end
else
tagged_dir = joinpath(dirname, tag)
gitrm_copy(target_dir, tagged_dir)
Expand Down