<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body bgcolor="#FFFFFF" text="#000000">
<p>There is an open request for this on GH, but it's not currently
done: <a class="moz-txt-link-freetext" href="https://github.com/rtfd/readthedocs.org/issues/1340">https://github.com/rtfd/readthedocs.org/issues/1340</a></p>
<p>At the PyCon US sprints this year, we added documentation
previews via netlify, and they have been super useful:
<a class="moz-txt-link-freetext" href="https://github.com/pypa/setuptools/pull/1367">https://github.com/pypa/setuptools/pull/1367</a> My understanding is
that other projects do something similar with CircleCI.</p>
<p>
It's not amazingly <i>difficult</i> for reviewers to fetch the
submitter's branch, build the documentation and review it locally,
but it's a decent number of extra steps for what <i>should</i> be
a very simple review. I think we all know that reviewer time and
effort is one of the biggest bottlenecks in the CPython
development workflow, and this could make it <i>much</i> easier
to do reviews.</p>
<p>Some of the concerns about increasing the surface area I think
are a bit overblown. I haven't seen any problems yet in the
projects that do this, and I don't think it lends itself to abuse
particularly well.<i> </i>Considering that the rest of the CI
suite lets you run arbitrary code on many platforms, I don't think
it's particularly more dangerous to allow people to generate
ephemeral static hosted web sites as well.</p>
<p><br>
Best.</p>
<p>Paul<br>
</p>
<div class="moz-cite-prefix">On 11/4/18 11:28 AM, Alex Walters
wrote:<br>
</div>
<blockquote type="cite"
cite="mid:010401d4745b$6fec9a90$4fc5cfb0$@sdamon.com">
<pre class="moz-quote-pre" wrap="">Doesn't read the docs already do this for pull requests? Even if it doesn't, don't the core maintainers of read the docs go to pycon? I wouldn't suggest read the docs for primary docs hosting for python, but they are perfectly fine for live testing pull request documentation without having to roll our own.
</pre>
<blockquote type="cite">
<pre class="moz-quote-pre" wrap="">-----Original Message-----
From: Python-Dev <python-dev-bounces+tritium-
<a class="moz-txt-link-abbreviated" href="mailto:list=sdamon.com@python.org">list=sdamon.com@python.org</a>> On Behalf Of Stephane Wirtel
Sent: Sunday, November 4, 2018 8:38 AM
To: <a class="moz-txt-link-abbreviated" href="mailto:python-dev@python.org">python-dev@python.org</a>
Subject: [Python-Dev] Get a running instance of the doc for a PR.
Hi all,
When we receive a PR about the documentation, I think that could be
interesting if we could have a running instance of the doc on a sub
domain of python.org.
For example, pr-10000-doc.python.org or whatever, but by this way the
reviewers could see the result online.
The workflow would be like that:
New PR -> build the doc (done by Travis) -> publish it to a server ->
once published, the PR is notified by "doc is available at URL".
Once merged -> we remove the doc and the link (hello bedevere).
I am interested by this feature and if you also interested, tell me.
I would like discuss with Julien Palard and Ernest W. Durbin III for a
solution as soon as possible.
Have a nice day,
Stéphane
--
Stéphane Wirtel - <a class="moz-txt-link-freetext" href="https://wirtel.be">https://wirtel.be</a> - @matrixise
_______________________________________________
Python-Dev mailing list
<a class="moz-txt-link-abbreviated" href="mailto:Python-Dev@python.org">Python-Dev@python.org</a>
<a class="moz-txt-link-freetext" href="https://mail.python.org/mailman/listinfo/python-dev">https://mail.python.org/mailman/listinfo/python-dev</a>
Unsubscribe: <a class="moz-txt-link-freetext" href="https://mail.python.org/mailman/options/python-dev/tritium">https://mail.python.org/mailman/options/python-dev/tritium</a>-
list%40sdamon.com
</pre>
</blockquote>
<pre class="moz-quote-pre" wrap="">
_______________________________________________
Python-Dev mailing list
<a class="moz-txt-link-abbreviated" href="mailto:Python-Dev@python.org">Python-Dev@python.org</a>
<a class="moz-txt-link-freetext" href="https://mail.python.org/mailman/listinfo/python-dev">https://mail.python.org/mailman/listinfo/python-dev</a>
Unsubscribe: <a class="moz-txt-link-freetext" href="https://mail.python.org/mailman/options/python-dev/paul%40ganssle.io">https://mail.python.org/mailman/options/python-dev/paul%40ganssle.io</a>
</pre>
</blockquote>
</body>
</html>