https://pulp.plan.io/https://pulp.plan.io/favicon.ico2018-02-12T19:40:20ZPulpPulp - Issue #3355: Getting an error building docs with Sphinx 1.7https://pulp.plan.io/issues/3355?journal_id=245052018-02-12T19:40:20Zdaviddavis
<ul></ul><p>Here are the lines causing the problems:</p>
<p><a href="https://github.com/encode/django-rest-framework/blob/master/rest_framework/serializers.py#L888" class="external">https://github.com/encode/django-rest-framework/blob/master/rest_framework/serializers.py#L888</a><br>
<a href="https://github.com/encode/django-rest-framework/blob/master/rest_framework/serializers.py#L895" class="external">https://github.com/encode/django-rest-framework/blob/master/rest_framework/serializers.py#L895</a></p>
<p>Escaping the asterisks in my local copy of this file with backslashes fixed the problem for me.</p> Pulp - Issue #3355: Getting an error building docs with Sphinx 1.7https://pulp.plan.io/issues/3355?journal_id=245282018-02-13T15:33:20Zdalleydalley@redhat.com
<ul><li><strong>Sprint/Milestone</strong> set to <i>54</i></li><li><strong>Triaged</strong> changed from <i>No</i> to <i>Yes</i></li></ul> Pulp - Issue #3355: Getting an error building docs with Sphinx 1.7https://pulp.plan.io/issues/3355?journal_id=245672018-02-15T17:00:51Zdaviddavis
<ul></ul><p>One thing I found that fixes the problem is to add docstring to ModelSerializer.create[0]. It looks like this prevents sphinx from looking up and parsing the docstring from DRF's ModelSerializer.create method (which has the offending problem). I don't think this is a good long-term solution though.</p>
<p>[0] <a href="https://github.com/pulp/pulp/blob/3.0-dev/pulpcore/pulpcore/app/serializers/base.py#L105" class="external">https://github.com/pulp/pulp/blob/3.0-dev/pulpcore/pulpcore/app/serializers/base.py#L105</a></p> Pulp - Issue #3355: Getting an error building docs with Sphinx 1.7https://pulp.plan.io/issues/3355?journal_id=245862018-02-16T14:31:18Zbizhangbizhang@redhat.com
<ul></ul><p>I opened a PR to upstream django-rest-framework, but it was rejected :(<br>
<a href="https://github.com/encode/django-rest-framework/pull/5832" class="external">https://github.com/encode/django-rest-framework/pull/5832</a></p>
<p>I think the next best solution is to go with @daviddavis's proposal in <a href="https://pulp.plan.io/issues/3355#note-3" class="external">https://pulp.plan.io/issues/3355#note-3</a></p> Pulp - Issue #3355: Getting an error building docs with Sphinx 1.7https://pulp.plan.io/issues/3355?journal_id=246032018-02-16T19:03:30Zbizhangbizhang@redhat.com
<ul><li><strong>Status</strong> changed from <i>NEW</i> to <i>POST</i></li><li><strong>Assignee</strong> set to <i>bizhang</i></li></ul><p>PR: <a href="https://github.com/pulp/pulp/pull/3333" class="external">https://github.com/pulp/pulp/pull/3333</a></p> Pulp - Issue #3355: Getting an error building docs with Sphinx 1.7https://pulp.plan.io/issues/3355?journal_id=246042018-02-16T19:08:55Zwerwtybihan.zh@gmail.com
<ul><li><strong>Status</strong> changed from <i>POST</i> to <i>MODIFIED</i></li></ul><p>Applied in changeset <a class="changeset" title="Add docstring to fix Sphinx 1.7 closes #3355 https://pulp.plan.io/issues/3355" href="https://pulp.plan.io/projects/pulp/repository/pulp/revisions/f6be2d71e7f914721a58d463a82fd2c9131e5749">pulp|f6be2d71e7f914721a58d463a82fd2c9131e5749</a>.</p> Pulp - Issue #3355: Getting an error building docs with Sphinx 1.7https://pulp.plan.io/issues/3355?journal_id=264322018-03-08T23:32:50Zbmbouterbmbouter@redhat.com
<ul><li><strong>Sprint</strong> set to <i>Sprint 32</i></li></ul> Pulp - Issue #3355: Getting an error building docs with Sphinx 1.7https://pulp.plan.io/issues/3355?journal_id=264572018-03-08T23:33:22Zbmbouterbmbouter@redhat.com
<ul><li><strong>Sprint/Milestone</strong> deleted (<del><i>54</i></del>)</li></ul> Pulp - Issue #3355: Getting an error building docs with Sphinx 1.7https://pulp.plan.io/issues/3355?journal_id=276342018-04-19T15:12:29Zdkliban@redhat.com
<ul><li><strong>Sprint/Milestone</strong> set to <i>3.0.0</i></li></ul> Pulp - Issue #3355: Getting an error building docs with Sphinx 1.7https://pulp.plan.io/issues/3355?journal_id=426742019-04-26T20:36:41Zbmbouterbmbouter@redhat.com
<ul><li><strong>Tags</strong> deleted (<del><i>Pulp 3, Pulp 3 MVP</i></del>)</li></ul> Pulp - Issue #3355: Getting an error building docs with Sphinx 1.7https://pulp.plan.io/issues/3355?journal_id=510172019-12-13T17:30:02Zbmbouterbmbouter@redhat.com
<ul><li><strong>Status</strong> changed from <i>MODIFIED</i> to <i>CLOSED - CURRENTRELEASE</i></li></ul>