Skip to content

fix #668 (local build of docs) #669

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

Merged
ranocha merged 1 commit into from
Jun 27, 2021
Merged

fix #668 (local build of docs) #669

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
using Documenter
import Pkg

# Fix for https://github.com/trixi-framework/Trixi.jl/issues/668
if (get(ENV, "CI", nothing) != "true") && (get(ENV, "TRIXI_DOC_DEFAULT_ENVIRONMENT", nothing) != "true")
push!(LOAD_PATH, dirname(@__DIR__))
end

using Trixi
using Trixi2Vtk
using Trixi2Img
Expand Down
2 changes: 1 addition & 1 deletion docs/src/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ mode [julia-emacs](https://github.com/JuliaEditorSupport/julia-emacs).

You can build the documentation of Trixi.jl locally by running
```bash
julia --project=docs docs/make.jl
julia --project=docs -e 'using Pkg; Pkg.instantiate(); include("docs/make.jl")'
```
from the Trixi.jl main directory. Then, you can look at the html files generated in
`docs/build`.
Expand Down