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.

Sign up for GitHub

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

Docs nav fix after 400 #591

Merged
merged 8 commits into from
Dec 4, 2023
Merged

Docs nav fix after 400 #591

Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c33bc4a
docs: add core documentation to user guide
younesStrittmatter Dec 2, 2023
cbf1387
docs: fix issue resulting from navigation.index extension
younesStrittmatter Dec 2, 2023
0fcbfbf
docs: add terminology page
younesStrittmatter Dec 2, 2023
3c06e0e
docs: fix broken path
younesStrittmatter Dec 2, 2023
31f77d1
Merge branch 'main' into docs-nav-fix-after-400
hollandjg Dec 4, 2023
430a889
docs: simplify core import
younesStrittmatter Dec 4, 2023
5e4bd19
docs: note Python 3.10 requirement
benwandrew Dec 4, 2023
5a9af21
docs: fix spacing and edit language
benwandrew Dec 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ plugins:
- name: core
import_url: "https://github.com/autoresearch/autora-core/?branch=main"
imports: [
"docs/*",
Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Changed and tested it.

"docs/cycle/*",
"docs/pipeline/*",
"docs/experimentalists/grid/*",
Expand Down Expand Up @@ -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'
Copy link
Collaborator

@benwandrew benwandrew Dec 3, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

this isn't really an advanced Experimentalist tutorial, is it?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

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.

Copy link
Member

Choose a reason for hiding this comment

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

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.

- Online Closed-Loop Discovery: 'user-cookiecutter/docs/index.md'
- Online Closed-Loop Discovery:
- 'user-cookiecutter/docs/index.md'
- User Guide:
- Installation: 'installation.md'
- Terminology: 'terminology.md'
- Core:
- Home: 'core/docs/index.md'
- Examples:
- 'core/docs/cycle/Basic Introduction to Functions and States.ipynb'
- 'core/docs/cycle/Combining Experimentalists with State.ipynb'
- 'core/docs/cycle/Linear and Cyclical Workflows using Functions and States.ipynb'
- Theorists:
- Home: 'theorist/index.md'
- DARTS: '!import https://github.com/autoresearch/autora-theorist-darts/?branch=main&extra_imports=["mkdocs/base.yml"]'
Expand Down