Add documenation to main --> render RTD #186
Merged
Conversation
This file contains 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
* Adding mkdir to CLI * pylint * Update ibridges/__main__.py Co-authored-by: qubixes <[email protected]> * Update ibridges/__main__.py Co-authored-by: qubixes <[email protected]> * Update ibridges/__main__.py Co-authored-by: qubixes <[email protected]> * Rename to mkcoll --------- Co-authored-by: qubixes <[email protected]>
* Adding moveing data objects and collections * Adding test for renaming * Renaming and adjusting tests.
* Check for host and port before checking network * Small changes --------- Co-authored-by: Staiger, Christine <[email protected]>
* Turning network_check into class method for GUI * Ruff
* Create install.rst * Adding install instructions * Update docs/source/install.rst Co-authored-by: qubixes <[email protected]> * Update docs/source/install.rst Co-authored-by: qubixes <[email protected]> --------- Co-authored-by: qubixes <[email protected]>
* Fix docstring formatting error * Add ruff to CI and fix small linting errors
* Add sync documentation. * add index * Update docs/source/sync.rst Co-authored-by: qubixes <[email protected]> * FOrmatting and small changes * Ruff --------- Co-authored-by: qubixes <[email protected]> Co-authored-by: Staiger, Christine <[email protected]>
* Update ipath with other documentation (#152) * Turning network_check into class method for GUI (#146) * Turning network_check into class method for GUI * Ruff * Install doc (#147) * Create install.rst * Adding install instructions * Update docs/source/install.rst Co-authored-by: qubixes <[email protected]> * Update docs/source/install.rst Co-authored-by: qubixes <[email protected]> --------- Co-authored-by: qubixes <[email protected]> * Fix docstring formatting error (#140) * Fix docstring formatting error * Add ruff to CI and fix small linting errors * Add sync documentation. (#148) * Add sync documentation. * add index * Update docs/source/sync.rst Co-authored-by: qubixes <[email protected]> * FOrmatting and small changes * Ruff --------- Co-authored-by: qubixes <[email protected]> Co-authored-by: Staiger, Christine <[email protected]> --------- Co-authored-by: qubixes <[email protected]> Co-authored-by: Staiger, Christine <[email protected]> * Formatting and cross referencing. --------- Co-authored-by: qubixes <[email protected]> Co-authored-by: Staiger, Christine <[email protected]>
* Add missing search for data_name
* Rework API documentation * TRying to add file to resolve conflict * Rremove added file * Adding to edit * Delete file again. --------- Co-authored-by: chstaiger <[email protected]> Co-authored-by: chStaiger <[email protected]>
* Don't use assert for control flow * Fix __main__.py Only throw exception when needed. * Update ibridges/path.py Co-authored-by: chStaiger <[email protected]> --------- Co-authored-by: chStaiger <[email protected]>
* Update iRODS path tutorial. * Refer to tutorials for iRODS paths in RTD * Some more hints on paths in cli doc * Adjustong README * Remove old tutorial * Small edits * Update docs/source/cli.rst Co-authored-by: Terrell Russell <[email protected]> --------- Co-authored-by: Terrell Russell <[email protected]>
Rewrite of the sync_data function so that it uses the walk functionality of the IrodsPath instead of duplicated effort. Performance should be roughly the same. This update also fixes some issues with the walk functionality of the IrodsPath and makes it much faster.
* Add tree for the iBridges CLI * Add options to tree - Ascii - depth - show-max * Make pylint happy * Add type annotations
The main goal is code reduction and using the similarities of the download/upload and sync functionality. As a direct benefit, the upload and download functions now also have a progress bar. Some other notable changes: - `--dry-run` for upload and download - IrodsPath.absolute_path becomes IrodsPath.absolute
…174) * Cleanup tutorials. Create a First steps tutorial for the impatient. * Review First steps * Update Irods-paths tutorial * Update working-with-data * Remove duplicate file --------- Co-authored-by: Raoul Schram <[email protected]>
* Fix behavior of parent property of IrodsPath * Fix the fix * Fix tests for new behavior
Add examples to many of the mostly used docstrings. Also contains a few tiny fixes.
* Adjust and spellcheck * Wording and spellcheck * Update docs/source/cli.rst Co-authored-by: qubixes <[email protected]> * LInk to CLI --------- Co-authored-by: qubixes <[email protected]>
* Don't perform operations for files/dataobjects If the checksum is the same. It is currently confusing that there is a difference between uploading collections and dataobjects in this regard. * Try fixing download
* Doc for Session. * Relation between prc and ibridges * Remove old search file * Adding data transfers and streaming * Clean output * Add metadata and search * Meta export * Update docs/source/data_transfers.rst Co-authored-by: qubixes <[email protected]> * Update docs/source/data_transfers.rst Co-authored-by: qubixes <[email protected]> * Update docs/source/data_transfers.rst Co-authored-by: qubixes <[email protected]> * Update docs/source/metadata.rst Co-authored-by: qubixes <[email protected]> * Update docs/source/metadata.rst Co-authored-by: qubixes <[email protected]> * Update docs/source/metadata.rst Co-authored-by: qubixes <[email protected]> * Clearer call out note * Update docs/source/metadata.rst Co-authored-by: qubixes <[email protected]> * Rewording * typos * rewording * Formatting * Formatting and wording --------- Co-authored-by: Staiger, Christine <[email protected]> Co-authored-by: qubixes <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
CLI:
API:
move/rename
Ensure host and network are given in environment
Doc pages to all classes
Update tutorials