Skip to content

Generate documentation for any branch. #41

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

Merged
merged 2 commits into from
Sep 14, 2023

Conversation

dhebbeker
Copy link
Member

@dhebbeker dhebbeker commented Sep 14, 2023

For convenience it would be nice to have a generated documentation for every branch which is under development. Currently there only is a documentation for the develop branch.

These modifications add the documentation of every branch to the GitHub page branch. The branch name is used as subdirectory. To access the GitHub page for a specific branch, just add the branch name to the GitHub page URL. For example for this branch, the generated documentation can be found here.

⚠️ A downside is, that these directories are not cleaned up. Even if a branch is deleted, the directory will continue to live. Manual clean-up is necessary.

@dhebbeker dhebbeker marked this pull request as ready for review September 14, 2023 19:19
@dhebbeker dhebbeker added documentation Improvements or additions to documentation CI infrastructure Anything related to automatic builds and checks. labels Sep 14, 2023
@dhebbeker dhebbeker merged commit a11d981 into develop Sep 14, 2023
@dhebbeker dhebbeker deleted the feature/generate-documentation-for-every-branch branch September 14, 2023 19:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI infrastructure Anything related to automatic builds and checks. documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant