Skip to content

Commit 0bc8a63

Browse files
committed
add various helkpful messages for finding the correct docs
1 parent f5abbf9 commit 0bc8a63

3 files changed

Lines changed: 14 additions & 1 deletion

File tree

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "DynamicalSystems"
22
uuid = "61744808-ddfa-5f27-97ff-6e42cc95d634"
33
repo = "https://github.com/JuliaDynamics/DynamicalSystems.jl.git"
4-
version = "3.6.6"
4+
version = "3.6.7"
55

66
[deps]
77
Attractors = "f3fd9213-ca85-4dba-9dfd-7fc91308fec7"

docs/src/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@ DynamicalSystems
88

99
## Introduction
1010

11+
12+
!!! info "Use the multi-docs version of the docs"
13+
Please make sure that you are using the multi-document version of the **DynamicalSystems.jl** where there is an overhead menu listing
14+
the various components of the **DynamicalSystems.jl!** library.
15+
If you are not sure, the link to this doc is here:
16+
<https://juliadynamics.github.io/DynamicalSystemsDocs.jl/dynamicalsystems/dev/>
17+
1118
Welcome to the documentation of **DynamicalSystems.jl**!
1219

1320
- If you have not used the library before, and would like to get started, then please read the [overarching tutorial](@ref tutorial) for the library.

docs/src/tutorial.jl

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -709,6 +709,12 @@ current_parameter(roessler, :c)
709709

710710
# ## Core components reference
711711

712+
# !!! warn "Potentially broken hyperlinks"
713+
# Depending on where and how you have accessed this page,
714+
# the hyperlinks to some data structures referrenced below may be "broken".
715+
# Instead, search the data structure name in the **global** search bar in the top
716+
# right of the documentation window.
717+
712718
# ```@docs
713719
# StateSpaceSet
714720
# DynamicalSystem

0 commit comments

Comments
 (0)