Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
mishaschwartz opened this issue Mar 7, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@mishaschwartz
Copy link
Collaborator

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
@mishaschwartz mishaschwartz added the documentation Improvements or additions to documentation label Mar 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants