bird-house/birdhouse-deploy

:books: [Documentation]: Are we missing files in `html_extra_path` when building docs?

Opened this issue · 0 comments

Description

The html_extra_path variable (in docs/source/conf.py) currently contains the following files:

html_extra_path = [
'birdhouse/README.rst',
'birdhouse/env.local.example',
'birdhouse/pavics-compose.sh',
'birdhouse/docker-compose.yml',
]

I'm pretty sure there are other files that should be included here as well.

If this variable is missing files, then if there is a reference link or download link to these files in the docs, it will result in a 404 error.

We need to do a review of the docs to make sure that all code files that are referenced in the docs are included here.

References

One example of this is:

for your organization. For an example of possible override, see how the `emu service <optional-components/emu/docker-compose-extra.yml>`_ (:download:`download </birdhouse/optional-components/emu/docker-compose-extra.yml>`)

where the optional-components/emu/docker-compose-extra.yml file is referenced but is not present in html_extra_path.

Information Value
Server/Platform URL
Related issues/PR
Related documentation