#352 1.55 Release
Merged by cqi. Opened by cqi.
cqi/rpkg release-1.55  into  master

Download 352.patch

This is the first release to use new documentation site to publish
release notes. CHANGELOGS.rst is updated to point out the link and
existing releases are moved to separate release notes page.

Signed-off-by: Chenxiong Qi cqi@redhat.com

Why do we have to update it every year?
copyright = u'%s, rpkg team' % datetime.date.today().year
plus corresponding import datetime of course.

I am not able to generate documentation same way as in fedpkg. What is the scenario?
I installed make and pythonX-sphinx. Then cd into doc directory and finally make html. make help do not work either for me.

Same as my comment to fedpkg, I'm not sure. I'll try to ask someone about this.

The original patch for documentation was written in 2017 but it was merged this year recently. That is why 2017 was here.

I am not able to generate documentation same way as in fedpkg. What is the scenario?
I installed make and pythonX-sphinx. Then cd into doc directory and finally make html. make help do not work either for me.

It also requires theme sphinx_rtd_theme. I'm using virtualenv, but your way should work as well.

What is the error or traceback raised when you make html?

Makefile is customized. Not sure why make help does not work at this moment.

python2 docker:
sphinx_rtd_theme is installed with pip. Also python2-cccolutils-1.5-6 is installed.

[root@7c8f5f96a16e doc]# make html
Traceback (most recent call last):
  File "generate_commands_docs.py", line 282, in <module>
    import pyrpkg.cli
  File "/root/src/rpkg/pyrpkg/__init__.py", line 13, in <module>
    import cccolutils
ModuleNotFoundError: No module named 'cccolutils'
make: *** [Makefile:24: generate-man-pages-list] Error 1
[root@7c8f5f96a16e doc]# make help                
make: *** No rule to make target 'help'.  Stop.

for python3 docker I would like to avoid pip3 - it is unable for me install:
pip3 install --user sphinx_rtd_theme

@onosek Is dnf builddep --spec rpkg.spec helpful?

@onosek I succeed to build doc with this command in a f28 container

cd path/to/rpkg
docker run --rm -v $(pwd):/code:Z -i -t registry.fedoraproject.org/fedora:28 /bin/bash -c "
dnf install -y 'dnf-command(builddep)' make python2-sphinx
cd
curl -O https://src.fedoraproject.org/rpms/rpkg/raw/master/f/rpkg.spec
dnf builddep -y --spec rpkg.spec
cd /code/doc
make html
"

I tested it on my python3 container. It needs proper command sphinx-build-3 to run it with only python3 libraries. So now I am able to generate documentation

rebased onto 4f3dd68f32b4ac516b57ff5da7aa485ebfb37a72

Agree with the change. Thanks.

Pull-Request has been merged by cqi

Metadata