Docs nav fix after 400 #591
Conversation
younesStrittmatter
requested review from
hollandjg,
musslick,
chadcwilliams,
benwandrew,
listar2000,
TheLemonPig,
blinodelka and
whyhardt
|
Also: Should work on the core documentation of the tutorials. Not sure if they are still up-to-date. But I still think this is better than having nothing at all in the user-guide (at least a start) |
| @@ -158,11 +159,19 @@ nav: | |||
| - III - Functional Workflow: 'tutorials/basic/Tutorial-III-Functional-Workflow.ipynb' | |||
| - IV - Customization: 'tutorials/basic/Tutorial-IV-Customization.ipynb' | |||
| - Advanced: | |||
| - Equation Discovery: 'tutorials/Equation Discovery.ipynb' | |||
| - Equation Discovery: 'theorist/Equation Discovery.ipynb' | |||
| - Experimentalists: 'tutorials/Experimentalist.ipynb' | |||
There was a problem hiding this comment.
this isn't really an advanced Experimentalist tutorial, is it?
There was a problem hiding this comment.
Yes, it was in the advanced tutorials before, but was a broken link. I just changed the path.
BTW: There is another tutorial file in the advanced folder called "Theorist.ipynb" that we don't use anywhere right now. I was not sure about that one either.
There was a problem hiding this comment.
We should also mark the theorist/Equation Discovery.ipynb file as requiring python3.10, because it uses the case-match statement which is first available then. (Or we should use the old if-elif-else syntax instead.) That would be a different PR though.
mkdocs.yml
Outdated
| @@ -36,6 +36,7 @@ plugins: | |||
| - name: core | |||
| import_url: "https://github.com/autoresearch/autora-core/?branch=main" | |||
| imports: [ | |||
| "docs/*", | |||
There was a problem hiding this comment.
I think you might be able to get away with just having docs/ and src/:
"docs/",
"src/",
... and all the others you can delete. They seem irrelevant. Also, I'm not sure what the "*" is doing, if anything.
There was a problem hiding this comment.
Changed and tested it.
Description
We should work on the documentation for core (the index file is currently merely a placeholder)