[docs] Add comprehensive documentation for PyOutline and PyCuerun#2212
Open
ramonfigueiredo wants to merge 1 commit intoAcademySoftwareFoundation:masterfrom
Open
Conversation
ramonfigueiredo
force-pushed
the
docs/pyoutline-pycuerun-documentation
branch
from
9c69a52 to
1bea885
Compare
- Add quick start guides for PyOutline and PyCuerun - Add concept pages explaining core architecture, lifecycle, and design - Add getting started guides for installation and first job submission - Add user guides covering layers, dependencies, sessions, and CLI usage - Add configuration guide for outline.cfg, plugins, and environment variables - Add sessions and data exchange guide for cross-layer communication - Add PyOutline API reference for all classes, methods, and constants - Add step-by-step tutorials (PyOutline and PyCuerun lessons) - Add developer guides covering architecture, testing, and extension points - Add PyCuerun entry to the glossary - Document the relationship between PyOutline (library) and PyCuerun (CLI) across all new docs
Collaborator
Author
|
@DiegoTavares / @lithorus I will update the documentation nav_order values using the commands below once the PR is approved. This allows you to focus specifically on the new files and text during your review. python extract_nav_orders.py
python renumber_nav_order.py
python update_nav_order.pyI tested all the commands and read the documentation many times. Looks good for me. |
ramonfigueiredo
force-pushed
the
docs/pyoutline-pycuerun-documentation
branch
from
1bea885 to
b9e1a17
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Link the Issue(s) this Pull Request is related to.
Summarize your change.