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

General doc update #706

Merged
merged 9 commits into from Oct 28, 2023
Merged

General doc update #706

merged 9 commits into from Oct 28, 2023

Conversation

TorkelE
Copy link
Member

@TorkelE TorkelE commented Oct 26, 2023

Preparing for the PEtab doc update.

  • Update the version of packages used for building docs.
  • Updates the Bifurcation tutorial for v 0.3.
  • Adds references at the bottom of certain doc pages (e.g. book on bifurcations at the bottom of the bifurcation tutorial).
    • Makes the coagulation tutorial use the same reference style (for stuff at the bottom) as other doc pages.

@isaacsas
Copy link
Member

Looks like the doc build shows some errors in the homotopy contin tutorial?

@TorkelE
Copy link
Member Author

TorkelE commented Oct 26, 2023

Yes, redoing. I had someone show me how to build the docs locally as well, should hopefully make it easier to check for these kinds of stuff.

@TorkelE
Copy link
Member Author

TorkelE commented Oct 26, 2023

When I formated the references like this:

[^1]: [Yuri A. Kuznetsov, *Elements of Applied Bifurcation Theory*, Springer (2023).](https://link.springer.com/book/10.1007/978-3-031-22007-4)

(to achieve the same format as we used elsewhere)

I get some warnings:

┌ Warning: unused footnote named '1' in src/catalyst_applications/bifurcation_diagrams.md.
└ @ Documenter.DocChecks ~/.julia/packages/Documenter/bYYzK/src/Utilities/Utilities.jl:34

which should be fine (unless there is some secondary effect causing problems, e.g. the references at the bottom being removed). It looks fine in the local build though.

Everything else should work.

@isaacsas
Copy link
Member

isaacsas commented Oct 27, 2023

@TorkelE
Copy link
Member Author

TorkelE commented Oct 27, 2023

Yes, tehre was a link that didn't work, should be fixed now.

@isaacsas
Copy link
Member

OK, if there are no more warnings/errors once the doc build finishes I'm happy for you to merge. (Ignoring the factorial warning from the MTK bug.)

@TorkelE
Copy link
Member Author

TorkelE commented Oct 27, 2023

Sorry. The doc build failed beacuse there were some stuff on master that wasn't here (the references to PEtab that I added directly. So I tried to reabse this on master. But that caused duplications where somehow this now marks having the same commits twice. Will try to figure out how to sort this out.

@TorkelE TorkelE merged commit 524489a into master Oct 28, 2023
8 of 9 checks passed
@ChrisRackauckas ChrisRackauckas deleted the general_doc_update branch November 8, 2023 06:03
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.

None yet

2 participants