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

Improve doc building process #649

Open
ianthomas23 opened this issue Feb 7, 2022 · 1 comment
Open

Improve doc building process #649

ianthomas23 opened this issue Feb 7, 2022 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@ianthomas23
Copy link
Contributor

When you build the docs locally or via CI, it rebuilds many old versions of the docs as well as the current ones. This isn't ideal as it takes a long time to do so, and uploading to the doc site uses a lot of bandwidth. Also, we should not recreate and upload old versions of the docs, they should remain as they were when released - the rebuilding may be using different versions of dependencies that causes the output to render differently.

So the proposal is to change the doc build system to only build a specific version (e.g. the latest tagged release, or current git HEAD). The hosting situation for the docs, and the automatic upload system also need to be considered so that they all continue to work together.

@ianthomas23 ianthomas23 added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 7, 2022
@ianthomas23
Copy link
Contributor Author

There is probably some issue about links between the different versions of the docs in the HTML pages, so this needs to be considered too.

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 enhancement New feature or request
Projects
Status: 📋 Backlog
Development

No branches or pull requests

2 participants