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.

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

Documentation Update #380

Merged
merged 22 commits into from
Jan 23, 2025
Merged

Documentation Update #380

merged 22 commits into from
Jan 23, 2025

Conversation

joezuntz
Copy link
Collaborator

@joezuntz joezuntz commented Jan 20, 2025

This adds partial or full documentation, mainly on files and file types.

It also updates various docstrings to make the sphinx-friendly.

Finally, it updates the list of stages.

Copy link
Contributor

@empEvil empEvil left a comment

Choose a reason for hiding this comment

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

I think we also need to update the file running.rst since it references running on nersc on cori.

docs/src/file_details/binned.rst Show resolved Hide resolved
docs/src/file_details/metadata.rst Outdated Show resolved Hide resolved
docs/src/file_details/supreme.rst Outdated Show resolved Hide resolved
docs/src/nersc.rst Outdated Show resolved Hide resolved
txpipe/calibrate.py Outdated Show resolved Hide resolved
@joezuntz
Copy link
Collaborator Author

Removed the mentions of "cori" too!

Copy link
Contributor

@empEvil empEvil left a comment

Choose a reason for hiding this comment

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

Great!, but I think we accidentally broke the link to the CC-IN2P3 installation details

@joezuntz
Copy link
Collaborator Author

Thanks - I fixed that broken link.

@joezuntz joezuntz merged commit c6768d8 into master Jan 23, 2025
3 checks passed
@joezuntz joezuntz deleted the doc-file-types branch January 23, 2025 09:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants