Initial setup of external docs#2
Merged
Merged
Conversation
rclune
commented
Apr 1, 2026
rclune
commented
Member
- Added the directory structure
- Updated the conf.py for the Rosetta site theme
- Created CLI argument reference documentation
- Started work on an installation guide
- Removed SLURM information from example scripts as these are system/user dependent
- Added the directory structure - Updated the conf.py for the Rosetta site theme - Created CLI argument reference documentation - Started work on an installation guide - Removed SLURM information from example scripts as these are system/user dependent
- added sphinx-argparse to the dependencies needed in the documentation workflow - added the installation guide placeholder to the index - updated the installation guide to add a few header labels
Collaborator
|
@rclune Looks great! I understand removing the SBATCH blocks from the examples, but we then lose the context that they are all using the mamba/conda environment rather than pixi/uv. I think we should add a note somewhere to clarify this and perhaps a minimal uv example like the |
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
3 participants
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.