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.

Sign up for GitHub

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

Jump to bottom

Update example page #2452

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

Update example page #2452

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6b5c64a
remove some example links (outdated, non-Documenter-v1, less informat…
hyrodium Feb 15, 2024
a078a45
update url with dev link
hyrodium Feb 15, 2024
c79d2df
update descriptions for each package, add link to Julia docs
hyrodium Feb 15, 2024
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
87 changes: 26 additions & 61 deletions docs/src/man/examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,72 +3,37 @@
Sometimes the best way to learn how to use a new package is to look for
examples of what others have already built with it.

The following packages use Documenter to build their documentation and so
should give a good overview of what this package is currently able to do.

!!! note

Packages are listed alphabetically. If you have a package that uses Documenter then
please open a PR that adds it to the appropriate list below; a simple way to do so
is to navigate to
<https://github.com/JuliaDocs/Documenter.jl/edit/master/docs/src/man/examples.md>.

The `make.jl` file for all listed packages will be tested to check for potential
regressions prior to tagging new Documenter releases whenever possible.

## Registered

Packages that have tagged versions available in the general Registry:

- [Augmentor.jl](https://evizero.github.io/Augmentor.jl/stable/)
- [BanditOpt.jl](http://rajvishnu.in/BanditOpt.jl/stable/)
- [BeaData.jl](https://stephenbnicar.github.io/BeaData.jl/stable/)
- [ControlSystems.jl](https://juliacontrol.github.io/ControlSystems.jl/stable/)
- [COSMO.jl](https://oxfordcontrol.github.io/COSMO.jl/stable/)
- [DiscretePredictors.jl](https://github.com/v-i-s-h/DiscretePredictors.jl)
- [Distributions.jl](https://juliastats.org/Distributions.jl/stable/)
- [Documenter.jl](https://documenter.juliadocs.org/stable/)
- [DrWatson](https://juliadynamics.github.io/DrWatson.jl/stable/)
- [EvolvingGraphs.jl](https://etymoio.github.io/EvolvingGraphs.jl/stable/)
- [ExtractMacro.jl](https://carlobaldassi.github.io/ExtractMacro.jl/stable/)
- [EzXML.jl](https://juliaio.github.io/EzXML.jl/stable/)
- [FourierFlows.jl](https://fourierflows.github.io/FourierFlowsDocumentation/stable/)
- [Gadfly.jl](https://gadflyjl.org/stable/)
- [GeophysicalFlows.jl](https://fourierflows.github.io/GeophysicalFlowsDocumentation/stable/)
- [GeoStats.jl](https://juliaearth.github.io/GeoStatsDocs/stable/)
- [Highlights.jl](https://highlights.juliadocs.org/stable/)
- [HypothesisTests.jl](https://juliastats.org/HypothesisTests.jl/stable/)
- [InvertibleNetworks.jl](https://slimgroup.github.io/InvertibleNetworks.jl/stable/)
- [JUDI.jl](https://slimgroup.github.io/JUDI.jl/stable/)
- [Luxor.jl](https://juliagraphics.github.io/Luxor.jl/stable/)
- [MergedMethods.jl](https://michaelhatherly.github.io/MergedMethods.jl/stable/)
- [Mimi.jl](https://www.mimiframework.org/Mimi.jl/stable/)
- [NumericSuffixes.jl](https://michaelhatherly.github.io/NumericSuffixes.jl/stable/)
- [NLOptControl.jl](https://huckl3b3rry87.github.io/MPCDocs.jl/stable/)
- [Oceananigans.jl](https://clima.github.io/OceananigansDocumentation/stable/))
- [OhMyREPL.jl](https://github.com/KristofferC/OhMyREPL.jl)
- [OnlineStats.jl](https://joshday.github.io/OnlineStats.jl/stable/)
- [PhotoAcoustic.jl](https://slimgroup.github.io/PhotoAcoustic.jl/stable/)
- [Pigeons.jl](https://pigeons.run/dev/)
- [POMDPs.jl](https://juliapomdp.github.io/POMDPs.jl/stable/)
- [PhyloNetworks.jl](https://crsl4.github.io/PhyloNetworks.jl/stable/)
- [PrivateModules.jl](https://michaelhatherly.github.io/PrivateModules.jl/stable/)
- [Query.jl](https://www.queryverse.org/Query.jl/stable/)
- [QuestDBClient.jl](https://ochibobo.github.io/QuestDBClient.jl/dev/)
- [SimGBS.jl](https://anshess.github.io/SimGBS.jl/stable/)
- [SlimOptim.jl](https://slimgroup.github.io/SlimOptim.jl/stable/)
- [SymbolicRegression.jl](https://astroautomata.com/SymbolicRegression.jl/stable/)
- [TaylorSeries.jl](https://juliadiff.org/TaylorSeries.jl/stable/)
- [Weave.jl](https://weavejl.mpastell.com/stable/)
- [WorldDynamics.jl](https://worlddynamics.github.io/WorldDynamics.jl/stable/)

## Documentation repositories
Nowadays most of Julia packages use Documenter.jl to build their documentation.
The following sites are based on Documenter.jl and so should give a good overview of what this package is currently able to do.
Please open a PR if the following description is not up-to-date.

- [Julia](https://docs.julialang.org/en/v1/)
- The Julia official documentation.
- [Documenter.jl](https://documenter.juliadocs.org/dev/)
- The documentation of Documenter.jl is built with Documenter.jl of course.
- The source of the docs might be complicated for beginngers, but still a good reference.
- [DrWatson.jl](https://juliadynamics.github.io/DrWatson.jl/dev/)
- DrWatson.jl has nice CSS customization which can be good reference.
Comment on lines +10 to +16
Copy link
Member

@goerz goerz Feb 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd keep this list in a more compressed format, focusing on what is special in their setup. Use the format - [name of package](link) – (en-dash) single paragraph that explains what is special about the Documenter setup of this particular package.

- [Julia](https://docs.julialang.org/en/v1/) — the official Julia documentation
- [Documenter.jl](https://documenter.juliadocs.org/dev/) – the `Documenter` documentation serves as its own showcase
- [DrWatson.jl](https://juliadynamics.github.io/DrWatson.jl/dev/) – use of custom CSS
...

- [GeophysicalFlows.jl](https://fourierflows.github.io/GeophysicalFlowsDocumentation/dev/)
- [Luxor.jl](https://juliagraphics.github.io/Luxor.jl/dev/)
- Luxor is a Julia package for drawing simple static 2D vector graphics.
- It has nice tutorials and examples.
- [Oceananigans.jl](https://clima.github.io/OceananigansDocumentation/dev/)
- The figures in the documentation is generated with [CairoMakie.jl](https://github.com/MakieOrg/Makie.jl) during the document generation.
- [FourierFlows.jl](https://fourierflows.github.io/FourierFlowsDocumentation/dev/)
- The figures in the documentation is generated with [CairoMakie.jl](https://github.com/MakieOrg/Makie.jl) during the document generation.
- [POMDPs.jl](https://juliapomdp.github.io/POMDPs.jl/dev/)
- [PhyloNetworks.jl](https://crsl4.github.io/PhyloNetworks.jl/dev/)

Some projects or organizations maintain dedicated documentation repositories that are
separate from specific packages.

- [DifferentialEquations.jl](https://diffeq.sciml.ai/dev/)
- This site is built with [MultiDocumenter.jl](https://github.com/JuliaComputing/MultiDocumenter.jl).
- [JuliaDocs landing page](https://juliadocs.org/)
- [JuliaImages](https://juliaimages.org)
- [JuliaImages](https://juliaimages.org/dev/)
- The site is a good example with [DemoCards.jl](https://github.com/JuliaDocs/DemoCards.jl)
- [JuliaMusic](https://juliamusic.github.io/JuliaMusic_documentation.jl/dev/)
- JuliaMusic site has nice CSS customization which can be good reference.
- [Plots.jl](https://docs.juliaplots.org/dev/)
- The documentation for Plots.jl.
Loading