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

[WIP] Fix remaining doc issues #943

Merged
merged 6 commits into from
Jun 11, 2024
Merged

[WIP] Fix remaining doc issues #943

merged 6 commits into from
Jun 11, 2024

Conversation

TorkelE
Copy link
Member

@TorkelE TorkelE commented Jun 10, 2024

Fixes remaining things that causes errors/warnings in the docs

@TorkelE TorkelE changed the title Fix remaining doc issues [WIP] Fix remaining doc issues Jun 10, 2024
Copy link
Member

@isaacsas isaacsas left a comment

Choose a reason for hiding this comment

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

Can we change the warning settings back to the SciML defaults now then?

@@ -1,7 +1,7 @@
# [Introduction to Catalyst](@id introduction_to_catalyst)
In this tutorial we provide an introduction to using Catalyst to specify
chemical reaction networks, and then to solve ODE, jump, and SDE models
generated from them. At the end we show what mathematical rate laws and
generated from them[1]. At the end we show what mathematical rate laws and
Copy link
Member

Choose a reason for hiding this comment

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

If this is supposed to be a reference then I'd just convert the list back to a footnote. I only switched it because it was giving errors when it was unreferenced.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ahh, was a bit unsure if that's what you were doing. I will check how the printed docs looks like, but converting back to a list makes sense.

@TorkelE
Copy link
Member Author

TorkelE commented Jun 10, 2024

Can we change the warning settings back to the SciML defaults now then?

Good point, agreed.

@isaacsas
Copy link
Member

I switched unreferenced footnote sections to lists, but if they are referenced it makes sense to keep them as footnotes.

@isaacsas
Copy link
Member

Feel free to merge after you are done with the updates.

@TorkelE TorkelE merged commit 6ccbc1f into master Jun 11, 2024
8 checks passed
@TorkelE TorkelE deleted the fix_broken_doc_references branch June 11, 2024 13:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants