#2 first pass at converting docs to sphinx-doc reStructured Text
Closed by mikem. Opened by maxamillion.
maxamillion/koji docs  into  master

Download 2.patch
no initial comment

Here's a rendered version of the docs https://docs.pagure.org/fork/maxamillion/koji/

Thanks for this.
Looks like this may cause problems with the parent makefile (recursive make install).
I'm a little fuzzy on how to used the docs module in pagure. Is your rendered example automatically generated by pagure from the main repo, or did you have to generate it locally and push to the (separate) docs repo?

Yeah, breaks the build

make[1]: Entering directory `/builddir/build/BUILD/koji-1.10.1/docs'
make[1]: Leaving directory `/builddir/build/BUILD/koji-1.10.1/docs'
Makefile:12: *** The 'sphinx-build' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the 'sphinx-build' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/.  Stop.
make: *** [install] Error 1
error: Bad exit status from /var/tmp/rpm-tmp.AjLVVb (%install)

The docs are written in reStructuredText and rendered using sphinx doc. I think it makes sense that it would need sphinx installed in order to perform the build from now on, or is that not acceptable?

Yeah.. that's just a BuildRequires: python-sphinx, right?

The patch as-is does not package the docs. It was somewhat unclear to me whether these docs were intended to be packaged, or only intended for the web.
Since they were not packaged, I assumed the latter, in which case it makes to sense to add a BuildRequires (and the docs generation should instead be decoupled from the rest of the build).
If we do want to package them, then we need to make that work.
With python-sphinx installed, the rpm build fails on make install in the docs dir

Rebased and merged with a fix

https://pagure.io/koji/c/102d325350b5ec465979d045af8ad33e80d31dc5

Enabled the pagure docs feature for koji and used the dirhtml output to populate it
https://pagure.io/docs/koji/

Pull-Request has been closed by mikem

Metadata