[Documentation] Improving documentation #24
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
luraess
reviewed
Jun 14, 2024
Co-authored-by: Ludovic Räss <[email protected]>
…e consideration by alterning workgroup size etc
luraess
reviewed
Jun 17, 2024
luraess
reviewed
Jun 17, 2024
luraess
reviewed
Jun 17, 2024
Co-authored-by: Ludovic Räss <[email protected]>
Co-authored-by: Ludovic Räss <[email protected]>
Co-authored-by: Ludovic Räss <[email protected]>
Co-authored-by: Ludovic Räss <[email protected]>
luraess
reviewed
Jul 23, 2024
| @@ -8,7 +8,8 @@ makedocs( | |||
| authors="Ivan Utkin, Ludovic Räss and contributors", | |||
| format = Documenter.HTML( | |||
| prettyurls=get(ENV, "CI", nothing) == "true", # easier local build | |||
| ansicolor=true | |||
| ansicolor=true, | |||
| assets = ["assets/favicon.ico"], | |||
There was a problem hiding this comment.
Ah cool - thanks for adding this missing step
luraess
reviewed
Jul 23, 2024
docs/src/getting_started.md
Outdated
| @@ -16,7 +16,7 @@ Introducing the diffusion flux $q$, we can rewrite equation `(1)` as a system of | |||
|
|
|||
| ```math | |||
| \begin{align} | |||
| \boldsymbol{q} &= -\chi \nabla C~, \\ | |||
| \boldsymbol{q} &= -\chi \nabla C~, \\[5pt] | |||
There was a problem hiding this comment.
I've added some spacing between the equations. There seems to be some rendering issues with the equation number in the margin (independently of adding spacing or not) in Safari.
There was a problem hiding this comment.
The issue seems to be the align environment. I don't know if this is a bug in LaTex rendering or Documenter, reverting for now to multiple equations
|
Ok, it's been brewing long enough, merging now. Thanks everyone for the contributions =) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR aims to add documentation for https://ptsolvers.github.io/Chmy.jl/dev/ and addresses the first and second TODOs in the issue #23.