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: adapted new structure for states and workflows #674

Merged
merged 2 commits into from
Nov 10, 2024
Merged

docs: adapted new structure for states and workflows #674

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
312303e
adapted new structure for states and workflows
musslick Oct 21, 2024
50d3193
Merge branch 'main' into doc/state-structure
musslick Nov 10, 2024
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
27 changes: 14 additions & 13 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,15 +203,21 @@ nav:
- User Guide:
- Installation: 'installation.md'
- Terminology: 'terminology.md'
- Core:
- States and Workflows:
- Home: 'core/docs/index.md'
- State: 'core/docs/The State Mechanism.ipynb'
- Variable: 'core/docs/Variable.ipynb'
- Examples:
- 'core/docs/cycle/Basic Introduction to Functions and States.ipynb'
- 'core/docs/cycle/Combining Experimentalists with State.ipynb'
- 'core/docs/cycle/Dynamically Extending and Altering the State.ipynb'
- 'core/docs/cycle/Linear and Cyclical Workflows using Functions and States.ipynb'
- AutoRA Variables: 'core/docs/Variable.ipynb'
- States:
- Overview: 'core/docs/The State Mechanism.ipynb'
- Basic Usage: 'core/docs/cycle/Basic Introduction to Functions and States.ipynb'
- Combining Experimentalists with States: 'core/docs/cycle/Combining Experimentalists with State.ipynb'
- Workflows with States:
- Overview: 'core/docs/cycle/Linear and Cyclical Workflows using Functions and States.ipynb'
- Dynamically Altering the State: 'core/docs/cycle/Dynamically Extending and Altering the State.ipynb'
- Workflows for HPCs:
- "Command Line Interface": "core/docs/cli/index.md"
- "Basic Usage": "core/docs/cli/basic-usage/README.md"
- "Using Cylc": "core/docs/cli/cylc-pip/README.md"
- "Using Cylc and Slurm": "core/docs/cli/cylc-slurm-pip/README.md"
- Theorists:
- Home: 'theorist/index.md'
- DARTS: '!import https://github.com/autoresearch/autora-theorist-darts/?branch=main&extra_imports=["mkdocs/base.yml"]'
Expand Down Expand Up @@ -260,11 +266,6 @@ nav:
- Firebase-Prolific: '!import https://github.com/autoresearch/autora-experiment-runner-firebase-prolific/?branch=main&extra_imports=["mkdocs/base.yml"]'
- Firebase: '!import https://github.com/autoresearch/autora-experiment-runner-experimentation-manager-firebase/?branch=main&extra_imports=["mkdocs/base.yml"]'
- Prolific: '!import https://github.com/autoresearch/autora-experiment-runner-recruitment-manager-prolific/?branch=main&extra_imports=["mkdocs/base.yml"]'
- "Command Line Interface":
- "Home": "core/docs/cli/index.md"
- "Basic Usage": "core/docs/cli/basic-usage/README.md"
- "Using Cylc": "core/docs/cli/cylc-pip/README.md"
- "Using Cylc and Slurm": "core/docs/cli/cylc-slurm-pip/README.md"
- Online Experiments:
- Home: 'online-experiments/index.md'
- Firebase: 'online-experiments/firebase.md'
Expand Down
Loading