-
Notifications
You must be signed in to change notification settings - Fork 4
Completed First Version of FuncADL Docs #201
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
Conversation
Adding the workflow into the branch.
Documentation updates
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.
Pull Request Overview
This pull request introduces comprehensive documentation for the FuncADL repository using Sphinx, establishing the foundational structure for user guides and API documentation. The documentation covers both generic FuncADL concepts and specific implementations for xAOD and Uproot backends.
- Adds complete Sphinx documentation structure with configuration files and build scripts
- Implements detailed xAOD documentation including setup guides, calibration tools, and query examples
- Establishes placeholder structure for Uproot documentation
- Configures GitHub Actions workflow for automated documentation deployment
Reviewed Changes
Copilot reviewed 15 out of 21 changed files in this pull request and generated 7 comments.
Show a summary per file
File | Description |
---|---|
documentation.md | Removes old documentation file to make way for new Sphinx-based structure |
docs/index.md | Main documentation index with navigation structure and overview |
docs/conf.py | Sphinx configuration with project metadata and theme settings |
docs/generic/*.md | Generic FuncADL concepts including query operators and structure |
docs/xAOD/*.md | Comprehensive xAOD-specific documentation and examples |
docs/uproot/*.rst | Placeholder files for future Uproot documentation |
docs/Makefile, docs/make.bat | Build scripts for documentation generation |
.github/workflows/docs.yml | GitHub Actions workflow for documentation deployment |
Comments suppressed due to low confidence (1)
docs/xAOD/select.md:105
- Missing closing parenthesis for the
.Select()
call. Should be.Select(lambda e: e.Jets("AntiKt10UFOCSSKJets"))
.
.Select(lambda e: e.Jets("AntiKt10UFOCSSKJets")
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 looks great. I don't like sphinx
- lets try Myst for the servicex-local. Partly because sphinx
needs make files (that is really really old school). :-)
That said, some minor clean up on wording, etc. But I think this is mostly ready to go!
Co-authored-by: Copilot <[email protected]>
Merging some of the copilot chagnes. Merging some of the copilot chagnes.
…and fix some spelling.
This pull request adds documentation to the FuncADL repo and adds a workflow for deployment. This version of the documentation sets up the outline of the docs. Generic information section added with query structure and query operators. Also, starts to implement xAOD information by showing how to setup with the ServiceX frontend. Also adds how to use the .Where() and .Select Functions().
Future work:
Add uproot information
Add more examples to current sections
Add tutorials that provide more step by step support.