[Pulp-dev] Building docs locally in dev-env?

Grant Gainey ggainey at redhat.com
Mon May 11 20:39:15 UTC 2020

Hey folks,

I am making some additions to the import-export docs and went to build them
locally so I could review formatting. Since the last time I did this a
month ago, I'm running into a problem.  docs/Makefile now assumes that "
http://pulp/..." will resolve to something, which it certainly does not for
my vagrant-box.

Is this a problem with my env? A problem with the Makefile? Or a problem
with the 'how to build the docs", docs, that is perhaps missing a step?

I'm also getting two docstring errors:

/home/vagrant/devel/pulpcore/pulpcore/app/models/exporter.py:docstring of
pulpcore.app.models.PulpExport::more than one target found for
cross-reference 'models.RepositoryVersion':


/home/vagrant/devel/pulpcore/pulpcore/tasking/tasks.py:docstring of
pulpcore.tasking.tasks.enqueue_with_reservation::more than one target found
for cross-reference 'models.TaskGroup': pulpcore.app.models.TaskGroup,

The solution is easy - explicitly specify pulpcore.app. But This didn't
bite me last time I generated the docs, and I'd like to make sure it's not
just a symptom of something More Wrong in my env

Thoughts, anyone?

Grant Gainey
Principal Software Engineer, Red Hat System Management Engineering
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/pulp-dev/attachments/20200511/d3514d0d/attachment.htm>

More information about the Pulp-dev mailing list