search

bird-house / birdhouse-deploy

Scripts and configurations to deploy the various birds and servers required for a full-fledged production platform
https://birdhouse-deploy.readthedocs.io/en/latest/
Apache License 2.0
4 stars 6 forks source link

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

Open mishaschwartz opened 8 months ago

mishaschwartz commented 8 months ago

Description

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

https://github.com/bird-house/birdhouse-deploy/blob/8218166d5c8c7163293a656930ff85762eff4b60/docs/source/conf.py#L175-L180

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:

https://github.com/bird-house/birdhouse-deploy/blob/8218166d5c8c7163293a656930ff85762eff4b60/birdhouse/README.rst?plain=1#L65

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