Skip to content

Commit

Permalink
Merge pull request #52 from FourierFlows/ncc/documenter-updates
Browse files Browse the repository at this point in the history
Some updates for Documenter and Literate
  • Loading branch information
navidcy authored Nov 24, 2021
2 parents 01d3c29 + 0300ae8 commit f4981b6
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
PassiveTracerFlows = "dc26d6a1-c8d5-50f2-8a17-f57a5c578a00"
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"

[compat]
Literate = "≥2.9.0"
Plots = "≥ 1.10.1"
11 changes: 6 additions & 5 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ examples = [
for example in examples
withenv("GITHUB_REPOSITORY" => "FourierFlows/PassiveTracerFlowsDocumentation") do
example_filepath = joinpath(EXAMPLES_DIR, example)
Literate.markdown(example_filepath, OUTPUT_DIR, documenter=true)
Literate.notebook(example_filepath, OUTPUT_DIR, documenter=true)
Literate.script(example_filepath, OUTPUT_DIR, documenter=true)
Literate.markdown(example_filepath, OUTPUT_DIR; flavor = Literate.DocumenterFlavor())
Literate.notebook(example_filepath, OUTPUT_DIR)
Literate.script(example_filepath, OUTPUT_DIR)
end
end

Expand Down Expand Up @@ -70,7 +70,8 @@ makedocs(

withenv("GITHUB_REPOSITORY" => "FourierFlows/PassiveTracerFlowsDocumentation") do
deploydocs( repo = "github.com/FourierFlows/PassiveTracerFlowsDocumentation.git",
versions = ["stable" => "v^", "v#.#", "dev" => "dev"],
push_preview = false
versions = ["stable" => "v^", "v#.#.#", "dev" => "dev"],
push_preview = false,
devbranch = "main"
)
end

2 comments on commit f4981b6

@navidcy
Copy link
Member Author

Choose a reason for hiding this comment

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

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Registration pull request created: JuliaRegistries/General/49297

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.6.0 -m "<description of version>" f4981b6d1714d9806f02f5a542c167a94616d931
git push origin v0.6.0

Please sign in to comment.