Make docs building easier

[bmbouter]

Right now you can build docs with:

oci-env shell
pip install -r /src/pulpcore/doc_requirements.txt
cd /src/pulpcore/docs
make diagrams html

It would be great if:

• There was an easy command to install the doc_requirements
• There was an easy way to call the make file command (passing through the args to make would be ideal)

[newswangerd]

Some notes on how to implement this, if anyone wants to give it a shot:

• New sub commands can be registered here: https://github.com/pulp/oci_env/blob/main/client/oci_env/main.py#L79
• Bash scripts can be easily added by:
  • Adding a script here: https://github.com/pulp/oci_env/tree/main/base/container_scripts
  • Any script in this directory can be executed by running client.exec_container_script("my_script.sh") (https://github.com/pulp/oci_env/blob/main/client/oci_env/utils.py#L276) (example: https://github.com/pulp/oci_env/blob/main/client/oci_env/commands.py#L81)

I would recommend creating a oci-env docs subcommand. I don't know enough about how docs work in pulp to make recommendations how how this command should work other than it might be a good idea to follow the patterns for the oci-env test command.

Possible usage for the docs subcommmand:

# Install the doc dependencies for PLUGIN_NAME and run COMMAND for that plugin's makefile
oci-env docs -i -p PLUGIN_NAME COMMAND

# Run COMMAND for that PLUGIN_NAME's docs makefile without installing docs dependencies
oci-env docs -p PLUGIN_NAME COMMAND

[lubosmj]

The section for docs building was already improved: