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

Change path for generated python client docs #470

Merged
merged 1 commit into from
Feb 13, 2025

Conversation

voetberg
Copy link
Contributor

Closes #414

Changing the paths variable appends the given source path during documentation generation (according to the mkdocstrings documentation)

Verified by this worked by adding an annoying little comment in the local rucio clone

...
class AccountClient(BaseClient):

    """Account client class for working with rucio accounts
    
    I am being annoying and testing some changes just by messing around here. 
    """

    ACCOUNTS_BASEURL = 'accounts'
...

And verifying it shows up in the generated docs

image

@bari12 bari12 merged commit e0a7a6d into rucio:main Feb 13, 2025
6 checks passed
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.

Inconsistent Source Usage in Documentation Generation Process
3 participants