Inconsistent Source Usage in Documentation Generation Process

[Geogouz]

I think that the documentation generation process in tools/build_documentation.sh inconsistently sources Rucio components from different locations.

Bin Help Documentation and REST API Documentation:

• Uses the locally cloned repository from /run_in_docker/rucio/ and generates documentation from the current codebase

Client API Documentation

• Uses the system-installed Rucio from /opt/venv/lib/python3.9/site-packages/rucio/, ignoring the locally cloned repository at /run_in_docker/rucio/

• In my case (as I wanted to consider/apply my client's modifications inside /run_in_docker/rucio/lib) I bypassed this by adding /run_in_docker/rucio/lib to PYTHONPATH (in the generate_docs.shright before the called generate_client_api_docs.sh).

-Is this behavior intentional?
-What's the intended workflow for testing client's documentation changes?

[voetberg]

a) That's certainly not intentional behavior to my knowledge.

b) The only thing testing the documentation changes is verifying the build works not checking the contents of them. I'm not sure of any method to verify changes went through though. If you have suggestions I'm all ears.