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

Fix doc links #748

Merged
merged 4 commits into from
Jun 29, 2023
Merged
Show file tree
Hide file tree
Changes from 2 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
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ A simple finite element toolbox written in Julia.

## Documentation

[![][docs-stable-img]][docs-stable-url]
[![][docs-dev-img]][docs-dev-url]
termi-official marked this conversation as resolved.
Show resolved Hide resolved

## Installation
Expand Down Expand Up @@ -42,8 +43,10 @@ Please keep in mind that we are part of the Julia community and adhere to the
[Julia Community Standards][standards].


[docs-dev-img]: https://img.shields.io/badge/docs-latest%20release-blue
[docs-dev-url]: http://ferrite-fem.github.io/Ferrite.jl/
[docs-stable-img]: https://img.shields.io/badge/docs-latest%20release-blue
[docs-stable-url]: http://ferrite-fem.github.io/Ferrite.jl/stable/
fredrikekre marked this conversation as resolved.
Show resolved Hide resolved
[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue
[docs-dev-url]: http://ferrite-fem.github.io/Ferrite.jl/dev/

[standards]: https://julialang.org/community/standards/
[julia-slack]: https://julialang.org/slack/
Expand Down
2 changes: 1 addition & 1 deletion docs/src/literate/computational_homogenization.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # Computational homogenization
# # [Computational homogenization](@id tutorial-computational-homogenization)
#
# ![](rve_homogenization.png)
#
Expand Down
2 changes: 1 addition & 1 deletion docs/src/literate/heat_equation.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # Heat Equation
# # [Heat Equation](@id tutorial-heat-equation)
#
# ![](heat_square.png)
#
Expand Down
2 changes: 1 addition & 1 deletion docs/src/literate/helmholtz.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # Helmholtz equation
# # [Helmholtz equation](@id tutorial-helmholtz)
#
# In this example, we want to solve a (variant of) of the [Helmholtz equation](https://en.wikipedia.org/wiki/Helmholtz_equation).
# The example is inspired by an [dealii step_7](https://www.dealii.org/8.4.1/doxygen/deal.II/step_7.html) on the standard square.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/literate/hyperelasticity.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # Hyperelasticity
# # [Hyperelasticity](@id tutorial-hyperelasticity)
#
# **Keywords**: *hyperelasticity*, *finite strain*, *large deformations*, *Newton's method*,
# *conjugate gradient*, *automatic differentiation*
Expand Down
2 changes: 1 addition & 1 deletion docs/src/literate/incompressible_elasticity.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # Incompressible Elasticity
# # [Incompressible Elasticity](@id tutorial-incompressible-elasticity)
#
#-
#md # !!! tip
Expand Down
2 changes: 1 addition & 1 deletion docs/src/literate/landau.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # Ginzburg-Landau model energy minimization
# # [Ginzburg-Landau model energy minimization](@id tutorial-ginzburg-landau-minimizer)

# ![landau_orig.png](landau_orig.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/src/literate/linear_shell.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # Linear shell
# # [Linear shell](@id tutorial-linear-shell)
#
# ![](linear_shell.png)
#-
Expand Down
2 changes: 1 addition & 1 deletion docs/src/literate/ns_vs_diffeq.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # Incompressible Navier-Stokes Equations via DifferentialEquations.jl
# # [Incompressible Navier-Stokes Equations via DifferentialEquations.jl](@id tutorial-ins-ordinarydiffeq)
#
# ![](https://user-images.githubusercontent.com/9196588/134514213-76d91d34-19ab-47c2-957e-16bb0c8669e1.gif)
#
Expand Down
2 changes: 1 addition & 1 deletion docs/src/literate/plasticity.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # von Mises plasticity
# # [von Mises plasticity](@id tutorial-plasticity)
#
# ![Shows the von Mises stress distribution in a cantilever beam.](plasticity.png)
#
Expand Down
2 changes: 1 addition & 1 deletion docs/src/literate/postprocessing.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # Postprocessing
# # [Postprocessing](@id tutorial-postprocessing)
#
# ![](heat_square_fluxes.png)
#
Expand Down
2 changes: 1 addition & 1 deletion docs/src/literate/quasi_incompressible_hyperelasticity.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # Nearly Incompressible Hyperelasticity
# # [Nearly Incompressible Hyperelasticity](@id tutorial-nearly-incompressible-hyperelasticity)
#
# ![](quasi_incompressible_hyperelasticity.gif)
#-
Expand Down
2 changes: 1 addition & 1 deletion docs/src/literate/stokes-flow.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # Stokes flow
# # [Stokes flow](@id tutorial-stokes-flow)
#
# **Keywords**: *periodic boundary conditions, multiple fields, mean value constraint*
#-
Expand Down
2 changes: 1 addition & 1 deletion docs/src/literate/threaded_assembly.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # Threaded Assembly
# # [Threaded Assembly](@id tutorial-threaded-assembly)
#
#-
#md # !!! tip
Expand Down
2 changes: 1 addition & 1 deletion docs/src/literate/topology_optimization.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # Topology optimization
# # [Topology optimization](@id tutorial-topology-optimization)
#
# **Keywords**: *Topology optimization*, *weak and strong form*, *non-linear problem*, *Laplacian*, *grid topology*
#
Expand Down
2 changes: 1 addition & 1 deletion docs/src/literate/transient_heat_equation.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # Time Dependent Problems
# # [Time Dependent Problems](@id tutorial-transient-heat-equation)
#
# ![](transient_heat.gif)
# ![](transient_heat_colorbar.svg)
Expand Down
142 changes: 71 additions & 71 deletions docs/src/tutorials/index.md

Large diffs are not rendered by default.