Skip to content

Commit

Permalink
Move docs to vitepress (#3861)
Browse files Browse the repository at this point in the history
* add vitepress, remove franklin

* delete unnecessary stuff

* use src folder, move index.md there

* make make run through

* move backend pages

* render start page video

* add backends page

* basic fix of home page images, without styling

* fix docs blocks for backends

* news page

* move api page

* use documenter for api page

* delete search

* move how-tos

* add figure block code

* add how-tos

* move backends page

* change title

* move aspect tutorial

* figure blocks in aspect tutorial

* change link paths

* use png by default because svg has some issues with blank plots

* render only pages

* add makiecore to api

* add basic tutorial

* add basic tutorial to page list

* remove unresolvable refs

* fix links

* add layout tutorial

* fix logic so continued code blocks don't repeat code

* move scenes tutorial

* fix scene tutorial

* move recipe wrapping tutorial

* move animation page

* move blocks page

* move cameras page

* move conversion pipeline

* add color page

* add dim converts

* rename

* fix continuity

* observables and events

* fix link

* move arrows docstring

* move figure

* move faq

* move fonts

* move headless

* move inspector

* move latex

* move layouting

* move plot methods

* move recipes

* try deploying preview

* don't cause precompilation twice

* add description from old page

* add logo and icon

* move scenes

* move specapi

* theming and predefined themes

* transparency

* remaining entries

* fix examples

* better headings

* readd missing sections

* adds blocks and scene (#3865)

adds blocks

* use capitalized titles

* add attrdocs block

* give blocks real docstrings that documenter can pick up

* remove `{{doc}}` for menu and slidergrid

* fix missing references

* remove waspressed

* add attrdocs ability for plot types

* arc arrows

* band barplot

* move rest

* examplefigure fixes

* attributes sections

* whitespace

* fixes

* add plots

* example

* fix

* Exclusively is exported

* remove useless overview pages

* fix links

* fix changelog md format

* copy_changelog.jl

* call it changelog

* link basic tutorial

* tweaks

* restructure and cleanup

* hide bibtex

* rprmakie fixes

* datashader fixes

* links

* non-canonical docstrings

* fix collisions

* fix links

* add figure docstring

* improve docstring

* improve

* fix link collisions another way

* add short docs for all plots

* add info

* fix bug and logic

* canonical false

* call the site just Makie

* fix description by using placeholder

* testing out relative link changes

* link change

* change deploy_url

* change homepage to just Makie

* use example syntax for wglmakie

* increase px_per_unit for GLMakie

* fix missing changelog entry

* move back to customized deploy version to match old franklin setup

* fix docstring warnings

* one folder up

* debug

* change path again

* try again, files should be moved

* delete old franklin things

* make image links relative

* remove base refs

* fix remaining problems

* disable warnonly, fail builds when there are problems

---------

Co-authored-by: Lazaro Alonso <lazarus.alon@gmail.com>
  • Loading branch information
jkrumbiegel and lazarusA authored May 24, 2024
1 parent 72179f0 commit ba304bf
Show file tree
Hide file tree
Showing 287 changed files with 2,494 additions and 12,159 deletions.
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -508,7 +508,8 @@ All other changes are collected [in this PR](https://github.com/MakieOrg/Makie.j
[Unreleased]: https://github.com/MakieOrg/Makie.jl/compare/v0.21.2...HEAD
[0.21.2]: https://github.com/MakieOrg/Makie.jl/compare/v0.21.0...v0.21.2
[0.21.1]: https://github.com/MakieOrg/Makie.jl/compare/v0.21.0...v0.21.1
[0.21.0]: https://github.com/MakieOrg/Makie.jl/compare/v0.20.9...v0.21.0
[0.21.0]: https://github.com/MakieOrg/Makie.jl/compare/v0.20.10...v0.21.0
[0.20.10]: https://github.com/MakieOrg/Makie.jl/compare/v0.20.9...v0.20.10
[0.20.9]: https://github.com/MakieOrg/Makie.jl/compare/v0.20.8...v0.20.9
[0.20.8]: https://github.com/MakieOrg/Makie.jl/compare/v0.20.7...v0.20.8
[0.20.7]: https://github.com/MakieOrg/Makie.jl/compare/v0.20.6...v0.20.7
Expand Down Expand Up @@ -554,3 +555,4 @@ All other changes are collected [in this PR](https://github.com/MakieOrg/Makie.j
[0.15.3]: https://github.com/MakieOrg/Makie.jl/compare/v0.15.2...v0.15.3
[0.15.2]: https://github.com/MakieOrg/Makie.jl/compare/v0.15.1...v0.15.2
[0.15.1]: https://github.com/MakieOrg/Makie.jl/compare/v0.15.0...v0.15.1
[0.15.0]: https://github.com/MakieOrg/Makie.jl/compare/v0.14.2...v0.15.0
25 changes: 25 additions & 0 deletions MakieCore/src/basic_plots.jl
Original file line number Diff line number Diff line change
Expand Up @@ -620,6 +620,31 @@ Draws a wireframe, either interpreted as a surface or as a mesh.
depth_shift = -1f-5
end

"""
arrows(points, directions; kwargs...)
arrows(x, y, u, v)
arrows(x::AbstractVector, y::AbstractVector, u::AbstractMatrix, v::AbstractMatrix)
arrows(x, y, z, u, v, w)
arrows(x, y, [z], f::Function)
Plots arrows at the specified points with the specified components.
`u` and `v` are interpreted as vector components (`u` being the x
and `v` being the y), and the vectors are plotted with the tails at
`x`, `y`.
If `x, y, u, v` are `<: AbstractVector`, then each 'row' is plotted
as a single vector.
If `u, v` are `<: AbstractMatrix`, then `x` and `y` are interpreted as
specifications for a grid, and `u, v` are plotted as arrows along the
grid.
`arrows` can also work in three dimensions.
If a `Function` is provided in place of `u, v, [w]`, then it must accept
a `Point` as input, and return an appropriately dimensioned `Point`, `Vec`,
or other array-like output.
"""
@recipe Arrows (points, directions) begin
"Sets the color of arrowheads and lines. Can be overridden separately using `linecolor` and `arrowcolor`."
color = :black
Expand Down
2 changes: 2 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@ __site/
node_modules/
package-lock.json
news.md
src/changelog.md
build/
28 changes: 0 additions & 28 deletions docs/404.md

This file was deleted.

5 changes: 1 addition & 4 deletions docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ DelaunayTriangulation = "927a84f5-c5f4-47a5-9785-b46e178433df"
DelimitedFiles = "8bb1440f-4735-579b-a4ab-409b98df4dab"
Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
DocumenterVitepress = "4710194d-e776-4893-9690-8d956a29c365"
FileIO = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549"
Franklin = "713c75ef-9fc9-4b05-94a9-213340da978e"
GLMakie = "e9467ef8-e4e7-5192-8a1a-b1aee30e663a"
GeometryBasics = "5c1252a2-5f33-56bf-86c9-59e7332b4326"
Gumbo = "708ec375-b3d6-5a57-a7ce-8257bf98657a"
Expand All @@ -27,6 +27,3 @@ Observables = "510215fc-4207-5dde-b226-833fc4488ee2"
RPRMakie = "22d9f318-5e34-4b44-b769-6e3734a732a6"
RadeonProRender = "27029320-176d-4a42-b57d-56729d2ad457"
WGLMakie = "276b4fcb-3e11-5398-bf8b-a0c2d153d008"

[compat]
Documenter = "<1"
Binary file removed docs/_assets/GitHub-Mark-120px-plus.png
Binary file not shown.
Binary file removed docs/_assets/GitHub-Mark-32px.png
Binary file not shown.
Binary file removed docs/_assets/GitHub-Mark-64px.png
Binary file not shown.
Binary file removed docs/_assets/GitHub-Mark-Light-120px-plus.png
Binary file not shown.
Binary file removed docs/_assets/GitHub-Mark-Light-32px.png
Binary file not shown.
Binary file removed docs/_assets/GitHub-Mark-Light-64px.png
Binary file not shown.
Binary file removed docs/_assets/bannermesh_gradient.png
Binary file not shown.
Binary file removed docs/_assets/bars.png
Binary file not shown.
1 change: 0 additions & 1 deletion docs/_assets/hamburger.svg

This file was deleted.

1 change: 0 additions & 1 deletion docs/_assets/makie_logo_transparent.svg

This file was deleted.

Binary file not shown.
Binary file removed docs/_assets/minimal-mistakes/mm-free-feature.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed docs/_assets/minimal-mistakes/zenobia.png
Binary file not shown.
Binary file removed docs/_assets/rndimg.jpg
Binary file not shown.
27 changes: 0 additions & 27 deletions docs/_assets/scripts/generate_results.jl

This file was deleted.

5 changes: 0 additions & 5 deletions docs/_assets/scripts/output/script1.out

This file was deleted.

Loading

0 comments on commit ba304bf

Please sign in to comment.