feat: initialize documentation directory #610
Merged
Conversation
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
f200d2f to
caf25c0
Compare
boczekbartek
approved these changes
May 29, 2025
| @@ -1,6 +1,6 @@ | |||
| [tool.poetry] | |||
| name = "rai_whoami" | |||
| version = "0.0.1" | |||
| version = "0.0.5" | |||
There was a problem hiding this comment.
Syncing with pypi. We are doing manual build & publish, which in the nearest future should be done automatically with auto version bump.
| def initialize_docs_directory(args: argparse.Namespace) -> None: | ||
| documentation_dir = Path(args.documentation_dir) | ||
| if os.path.exists(documentation_dir): | ||
| print( |
There was a problem hiding this comment.
I thought about it, decided to go with the simples option for such scripts.
| parser = argparse.ArgumentParser() | ||
| parser.add_argument("documentation_dir", type=Path) | ||
| args = parser.parse_args() | ||
| initialize_docs_directory(args) |
There was a problem hiding this comment.
Suggested change
| initialize_docs_directory(args) | |
| initialize_docs_directory(**vars(args)) |
There was a problem hiding this comment.
Never seen that, I will keep the same style as other script files.
|
@boczekbartek your proficiency with pathlib is nothing short of exquisite <3. |
Co-authored-by: Bartek Boczek <bartlomiej.boczek@robotec.ai>
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.
Review and Merge after #609
Purpose
Reducing manual effort needed to start with rai-whoami
Proposed Changes
Provided convenience script for setting up required documentation structure.
Issues
N/A
Testing
Used the script.
remember to
pip install src/rai_whoamias poetry does not install scripts.