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

Misc fixes #898

Merged
merged 6 commits into from
Dec 3, 2018
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 @@ -29,6 +29,8 @@

* ![Enhancement][badge-enhancement] Build output logging has been improved and switched to the logging macros from `Base`. ([#876][github-876])

* ![Enhancement][badge-enhancement] The default `documenter.sty` LaTeX preamble now include `\usepackage{graphicx}` ([#898][github-898]).

## Version `v0.20.0`

* Documenter v0.20 requires at least Julia v0.7. ([#795][github-795])
Expand Down Expand Up @@ -135,6 +137,7 @@
[github-876]: https://github.com/JuliaDocs/Documenter.jl/pull/876
[github-879]: https://github.com/JuliaDocs/Documenter.jl/pull/879
[github-885]: https://github.com/JuliaDocs/Documenter.jl/pull/885
[github-898]: https://github.com/JuliaDocs/Documenter.jl/pull/898


[badge-breaking]: https://img.shields.io/badge/BREAKING-red.svg
Expand Down
4 changes: 4 additions & 0 deletions assets/latex/documenter.sty
Original file line number Diff line number Diff line change
Expand Up @@ -75,3 +75,7 @@
\setheaderspaces{1in}{*}{*}
\checkandfixthelayout
%

% images etc.
\usepackage{graphicx}
fredrikekre marked this conversation as resolved.
Show resolved Hide resolved
%
3 changes: 3 additions & 0 deletions docs/src/lib/internals/writers.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,6 @@ Modules = [
Documenter.Writers.LaTeXWriter,
]
```
```@docs
Documenter.Plugin
```
49 changes: 21 additions & 28 deletions docs/src/man/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,33 +21,33 @@ should give a good overview of what this package is currently able to do.
Packages that have tagged versions available in `METADATA.jl`.

- [Augmentor.jl](https://evizero.github.io/Augmentor.jl/)
- [BanditOpt.jl](https://v-i-s-h.github.io/BanditOpt.jl/latest/)
- [BeaData.jl](https://stephenbnicar.github.io/BeaData.jl/latest/)
- [Bio.jl](https://biojulia.net/Bio.jl/latest/)
- [ControlSystems.jl](http://juliacontrol.github.io/ControlSystems.jl/latest/)
- [Currencies.jl](https://juliafinance.github.io/Currencies.jl/latest/)
- [BanditOpt.jl](https://v-i-s-h.github.io/BanditOpt.jl/stable/)
- [BeaData.jl](https://stephenbnicar.github.io/BeaData.jl/stable/)
- [Bio.jl](https://biojulia.net/Bio.jl/stable/)
- [ControlSystems.jl](http://juliacontrol.github.io/ControlSystems.jl/stable/)
- [Currencies.jl](https://juliafinance.github.io/Currencies.jl/stable/)
- [DiscretePredictors.jl](https://github.com/v-i-s-h/DiscretePredictors.jl)
- [Documenter.jl](https://juliadocs.github.io/Documenter.jl/latest/)
- [EvolvingGraphs.jl](https://etymoio.github.io/EvolvingGraphs.jl/latest/)
- [ExtractMacro.jl](https://carlobaldassi.github.io/ExtractMacro.jl/latest/)
- [EzXML.jl](https://bicycle1885.github.io/EzXML.jl/latest/)
- [FourierFlows.jl](https://FourierFlows.github.io/FourierFlows.jl/latest/)
- [Documenter.jl](https://juliadocs.github.io/Documenter.jl/stable/)
- [EvolvingGraphs.jl](https://etymoio.github.io/EvolvingGraphs.jl/stable/)
- [ExtractMacro.jl](https://carlobaldassi.github.io/ExtractMacro.jl/stable/)
- [EzXML.jl](https://bicycle1885.github.io/EzXML.jl/stable/)
- [FourierFlows.jl](https://FourierFlows.github.io/FourierFlows.jl/stable/)
- [Gadfly.jl](http://gadflyjl.org/stable/)
- [GeoStats.jl](http://juliohm.github.io/GeoStats.jl/latest/)
- [Highlights.jl](https://juliadocs.github.io/Highlights.jl/latest/)
- [IntervalConstraintProgramming.jl](https://juliaintervals.github.io/IntervalConstraintProgramming.jl/latest/)
- [GeoStats.jl](http://juliohm.github.io/GeoStats.jl/stable/)
- [Highlights.jl](https://juliadocs.github.io/Highlights.jl/stable/)
- [IntervalConstraintProgramming.jl](https://juliaintervals.github.io/IntervalConstraintProgramming.jl/stable/)
- [Luxor.jl](https://juliagraphics.github.io/Luxor.jl/stable/)
- [MergedMethods.jl](https://michaelhatherly.github.io/MergedMethods.jl/latest/)
- [MergedMethods.jl](https://michaelhatherly.github.io/MergedMethods.jl/stable/)
- [Mimi.jl](http://anthofflab.berkeley.edu/Mimi.jl/stable/)
- [NumericSuffixes.jl](https://michaelhatherly.github.io/NumericSuffixes.jl/latest/)
- [NLOptControl.jl](https://juliampc.github.io/MPCDocs.jl/latest/)
- [NumericSuffixes.jl](https://michaelhatherly.github.io/NumericSuffixes.jl/stable/)
- [NLOptControl.jl](https://huckl3b3rry87.github.io/MPCDocs.jl/stable/)
- [OhMyREPL.jl](https://github.com/KristofferC/OhMyREPL.jl)
- [OnlineStats.jl](http://joshday.github.io/OnlineStats.jl/latest/)
- [POMDPs.jl](http://juliapomdp.github.io/POMDPs.jl/latest/)
- [PhyloNetworks.jl](http://crsl4.github.io/PhyloNetworks.jl/latest/)
- [PrivateModules.jl](https://michaelhatherly.github.io/PrivateModules.jl/latest/)
- [OnlineStats.jl](https://joshday.github.io/OnlineStats.jl/stable/)
- [POMDPs.jl](http://juliapomdp.github.io/POMDPs.jl/stable/)
- [PhyloNetworks.jl](http://crsl4.github.io/PhyloNetworks.jl/stable/)
- [PrivateModules.jl](https://michaelhatherly.github.io/PrivateModules.jl/stable/)
- [Query.jl](http://www.queryverse.org/Query.jl/stable/)
- [TaylorSeries.jl](http://www.juliadiff.org/TaylorSeries.jl/latest/)
- [TaylorSeries.jl](http://www.juliadiff.org/TaylorSeries.jl/stable/)
- [Weave.jl](http://weavejl.mpastell.com/stable/)

## Documentation repositories
Expand All @@ -59,10 +59,3 @@ separate from specific packages.
- [JuliaDocs landing page](https://juliadocs.github.io/latest/)
- [JuliaMusic](https://juliamusic.github.io/JuliaMusic_documentation.jl/latest/)
- [Plots.jl](https://docs.juliaplots.org/latest/)

## Unregistered

Packages that are not available in `METADATA.jl` and may be works-in-progress.
Please do take that into consideration when browsing this list.

- [AnonymousTypes.jl](https://michaelhatherly.github.io/AnonymousTypes.jl/latest/)
fredrikekre marked this conversation as resolved.
Show resolved Hide resolved
4 changes: 3 additions & 1 deletion src/Documenter.jl
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,10 @@ using DocStringExtensions
import Base64: base64decode

"""
abstract type Plugin end

Any plugin that needs to either solicit user input or store information in a
[`Documents.Document`](@ref) should create a subtype of [`Plugin`](@ref). The
[`Documents.Document`](@ref) should create a subtype of `Plugin`. The
subtype, `T <: Documenter.Plugin`, must have an empty constructor `T()` that
initialized `T` with the appropriate default values.

Expand Down
4 changes: 2 additions & 2 deletions src/Documents.jl
Original file line number Diff line number Diff line change
Expand Up @@ -386,8 +386,8 @@ end
"""
getplugin(doc::Document, T)

Retrieves the [`Plugin`](@ref) type for `T` stored in `doc`. If `T` was passed to
[`makedocs`](@ref), the passed type will be returned. Otherwise, a new `T` object
Retrieves the [`Plugin`](@ref Documenter.Plugin) type for `T` stored in `doc`. If `T` was passed to
[`makedocs`](@ref Documenter.makedocs), the passed type will be returned. Otherwise, a new `T` object
will be created using the default constructor `T()`.
"""
function getplugin(doc::Document, plugin_type::Type{T}) where T <: Plugin
Expand Down
2 changes: 1 addition & 1 deletion src/Utilities/Utilities.jl
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ function check_kwargs(kws)
for (k, v) in kws
println(out, " ", k, " = ", v)
end
warn(String(take!(out)))
@warn(String(take!(out)))
end

# Finding submodules.
Expand Down