Additional Autodocs #471
Merged
Additional Autodocs #471
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
…r tools, and did_meta_plugins
voetberg
force-pushed
the
policy_autodocs
branch
from
41412c2 to
11e44f4
Compare
bari12
approved these changes
Feb 13, 2025
rdimaio
reviewed
Feb 13, 2025
| @@ -28,6 +28,8 @@ VO. In this case, the configuration parameter or environment variable name | |||
| is suffixed with the VO name (for example, `package-vo1` or | |||
| `RUCIO_POLICY_PACKAGE_VO1`). | |||
|
|
|||
| [The API for policy packages can be found here.](pathname:///html/rse_policies/rsemanager.html) | |||
There was a problem hiding this comment.
Not sure if it could be confusing to call this the API for policy packages - most functions listed here https://rucio.github.io/documentation/html/rse_policies/rsemanager.html seem to be unrelated to policy packages
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.
Auto generate documentation for policies, transfer protocols, transfer tools, and did_meta_plugins
Fine grained changes:
generate_policy_documentation.shfile, to create 4 different html sites using mkdocsyqto update the yaml files - used to change the mkdocs.yml between making those new sites. Made the judgement that it's better to change the yaml and deal with an additional depedency than try to maintain 5 versions of roughly the same filesiteused for the client api to the more descriptiveclient_apiCloses #368