-
Notifications
You must be signed in to change notification settings - Fork 100
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
Transfer all high level docs from Turing.jl #375
Conversation
040a0f6
to
c614595
Compare
@cgbotta I added default project files to all docs. The default environment only installs |
tutorials/for-developers-abstractmcmc-turing/how_turing_implements_abstractmcmc.md
Outdated
Show resolved
Hide resolved
tutorials/for-developers-abstractmcmc-turing/how_turing_implements_abstractmcmc.md
Outdated
Show resolved
Hide resolved
d956b5a
to
9fbe7e1
Compare
When I try to weave the new tutorials using I recall that there was one place where I needed to manually add new tutorials to the weave scripts, but this list seems to have been removed in @devmotion 's recent work. Am I overlooking something? |
tutorials/using-turing/index.jmd
Outdated
@@ -0,0 +1,20 @@ | |||
--- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file does not contain any code or examples but is just a landing page on the webpage it seems, so I wonder:
Should this file be added here? Or should it be a regular markdown file? Or at least, do we really have to add Project.toml + Manifest.toml files here?
I guess you might refer to the manual list in the CompatHelper github action? The whole action was removed and replaced with an action that updates all Manifest.toml files (run once every week), so you're right, you don't have to add new tutorials/docs to some list anymore. However, that list was only relevant for CI (or more specifically CompatHelper) and completely independent from the There were no changes to the Regarding the new jmd files in this PR, it seems in the previous PR the non-tutorial jmd file was put in the tutorials folder but with a |
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…ents_abstractmcmc.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…ents_abstractmcmc.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
tutorials/08-multinomial-logistic-regression/08_multinomial-logistic-regression.jmd
Show resolved
Hide resolved
tutorials/08-multinomial-logistic-regression/08_multinomial-logistic-regression.jmd
Show resolved
Hide resolved
Co-authored-by: Hong Ge <[email protected]>
* abstract-mcmc * Rename files
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
I think this PR should not have been merged - I really think we should fix #394 before any other changes in this repo. Since it is not resolved all the docs and all the examples will be built and run with Julia 1.6 - but since Turing > 0.22 is not compatible with Julia 1.6 anymore, docs will be generated with a quite old version of Turing and in particular are not representative of the latest release (the versioning on the webpage has been misleading for a long time, even though the tutorials are listed as /v26/ they do not use Turing 0.26). |
Merging this PR is an incremental step, but it doesn’t solve all problems. Next, we can make a concerted effort to upgrade all docs and tutorials to Julia 1.9. |
Many thanks for the help, especially @cgbotta, who did most of the heavy work! |
This PR transfers all high-level (i.e. non-API or doc-string) documentation from
Turing.jl
. This allows us to unify most docs and tutorials workflow and pave the way to simplify build steps (we only need standard Jekyll eventually) in theturing.ml
repo.Steps
Turing.jl
(maybe a subfoldermultidoc
within theturing.ml
repo: Setup multidoc for Turing packages turinglang.github.io#41 preview)turing.ml
by removing allDocumenter
-specific scriptsTODO