On Mon, Nov 25, 2024, at 8:22 AM, Jakub Darmach wrote:

Hello everyone,

I've been updating documentation in kolla-ansible and noticed that while replacing variable content works in https://docs.openstack.org/kolla-ansible it fails to replace the variable with proper content in https://docs.openstack.org/project-deploy-guide/kolla-ansible.

If I understand correctly, it's being substituted with var having proper content in here: https://opendev.org/openstack/kolla-ansible/src/branch/master/doc/source/con...

Later on used in https://opendev.org/openstack/kolla-ansible/src/branch/master/doc/source/con...

And now for the example - |KOLLA_BRANCH_NAME| variable: Working substitution: https://docs.openstack.org/kolla-ansible/latest/user/operating-kolla.html#to... https://opendev.org/openstack/kolla-ansible/src/branch/master/doc/source/use...

Failed to render content: https://docs.openstack.org/project-deploy-guide/kolla-ansible/latest/quickst... https://opendev.org/openstack/kolla-ansible/src/branch/master/doc/source/use...

The var seems to be used the same in both examples, I suspect slightly different configuration on project end of the things. Can anyone advise where should I start looking?

The https://opendev.org/openstack/kolla-ansible/src/branch/master/doc/source/use... link is unlikely to ever render this the way you want because gitea is doing a basic rst render (with pandoc?) and not doing a sphinx build. You are correct that the problem is different configurations. If you look in tox.ini you'll see that normal docs run one command [0] and deploy guide docs use another [1]. The key piece of information from these commands is the path used to build. Docs uses doc/source (which will use this config file [2]) and the deploy guide uses deploy-guide/source (which will use this config file [3]). Sure enough the config file at [3] doesn't define these variables. [0] https://opendev.org/openstack/kolla-ansible/src/branch/master/tox.ini#L64 [1] https://opendev.org/openstack/kolla-ansible/src/branch/master/tox.ini#L72 [2] https://opendev.org/openstack/kolla-ansible/src/branch/master/doc/source/con... [3] https://opendev.org/openstack/kolla-ansible/src/branch/master/deploy-guide/s...