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 build clutters git pull #83

Closed
wysiwyng opened this issue Sep 23, 2021 · 1 comment · Fixed by #120
Closed

Documentation build clutters git pull #83

wysiwyng opened this issue Sep 23, 2021 · 1 comment · Fixed by #120

Comments

@wysiwyng
Copy link
Contributor

wysiwyng commented Sep 23, 2021

Currently the Doxygen documentation is built and updated on every push to this repo, and the resulting html files committed to the gh-pages branch in this repo. While this practice guarantees up-to-date documentation, it also implies that this gh-pages branch is always updated on your local working folder if you run a git pull, resulting in a download of several 100 Mbytes.

Some ideas are:

  • Trigger documentation build manually, or only if tags are pushed
  • Host the documentation elsewhere (VP-Vibes? Wiki Repository?)
@wysiwyng wysiwyng mentioned this issue Oct 24, 2021
@wysiwyng
Copy link
Contributor Author

In addition to documentation, the performance regression testing introduced with #77 also needs a place to store its data. Currently, this is the benchmark_results branch on the main repository. As above, doing things this way is easy but clutters the repository with unrelated stuff.

For the performance history in particular, storing it in the wiki repository of this repo should work nicely. Manual accessibility would suffer of course, unless this data is stored visibly embedded in some actual wiki page, instead of plain JSON.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant