search

openSUSE / dbxincluder

Transclusions for DocBook with XInclude 1.1
https://opensuse.github.io/dbxincluder
GNU General Public License v3.0
2 stars 3 forks source link

Deploy Documentation on GitHub Pages #11

Closed tomschr closed 8 years ago

tomschr commented 8 years ago

It would be nice to have an up-to-date documentation published on GitHub Pages after a successful Travis build.

Requirements:

It should limit the build for the master and develop branches only (use the --branches option). You also need to create a token on GitHub which is then pasted in the Travis settings dialog. Find more information on its homepage https://github.com/Syntaf/travis-sphinx

Vogtinator commented 8 years ago

It should limit the build for the master and develop branches only

Isn't it either-or? Wouldn't the documentation for develop overwrite the documentation for master if both branches are specified?

tomschr commented 8 years ago

Isn't it either-or? Wouldn't the documentation for develop overwrite the documentation for master if both branches are specified?

Good catch. Probably yes. The question is, if we want it.

My assumption was that both are (should be?) useful. When you create a release on master, it should overwrite anything that was deployed on develop before. On the other side, if you change anything in develop, it will be also published (assuming the there are doc changes).

If we allow publishing only on master, documentation is not always up-to-date. Depends probably on how often we create a release.

I'm open for suggestions. :)

Vogtinator commented 8 years ago

I wonder if is possible with travis-sphinx to upload the documentation into a subdirectory on gh-pages. I doubt that though, as that sounds like it breaks down with concurrent builds.

tomschr commented 8 years ago

I wonder if is possible with travis-sphinx to upload the documentation into a subdirectory on gh-pages.

As far as I know, I don't think this is possible.

Vogtinator commented 8 years ago

IMO it makes sense to only deploy documentation of the master branch. Those using the develop branch either don't need the documentation or are able to build it manually.

Vogtinator commented 8 years ago

I'll implement this after there is a generatable documentation in the master branch.

tomschr commented 8 years ago

Sounds good to me. :+1:

Vogtinator commented 8 years ago

Fixed, now with a clean usable design: https://opensuse.github.io/dbxincluder