nfft icon indicating copy to clipboard operation
nfft copied to clipboard

Automatic deployment of asciidoc manual to GitHub releases.

Open jenskeiner opened this issue 7 years ago • 2 comments

The current TravisCI set up is such that when building from a tag, it will upload the complete source package to create a release on GitHub. In addition, documentation assets, preferably the previously added asciidoc manual, should be uploaded as well.

jenskeiner avatar Aug 16 '17 19:08 jenskeiner

As far as I can see, this would just require further build instructions.

We could instruct the CI to execute a certain build command which not only depends on the library (source package) but also on the according documentation(s) to be zipped into the release package, as well.

kevinmatthes avatar Oct 30 '21 16:10 kevinmatthes

How about automatically uploading the documentation in a pre-compiled / self-compiling form into a separate repository within the NFFT namespace? Or into the wiki section of this repository?

For instance, the separate repository could hold this one as a submodule with the CI instructions to automatically render the hole documentation. We would just need to

  • set up the separate repository.
  • instruct it with the documentation creation as CI operation.
  • link the separate repository in README.md for reference ("Users who seek the documentation may find it there.").
  • update the separate repository once per release for assuring the latest version of the documentation(s). Maybe this can be done as well by the CI instructions, I am not that familiar with it, yet.

kevinmatthes avatar Oct 30 '21 16:10 kevinmatthes