[Python-Dev] Get a running instance of the doc for a PR.

[Brett Cannon]

On Sun, 4 Nov 2018 at 14:49, Steven D'Aprano <steve at pearwood.info> wrote:

> On Sun, Nov 04, 2018 at 05:05:07PM +0100, Stephane Wirtel wrote:
>
> > >If I am making doc patches, shouldn't I be doing that *before* I
> > >submit the PR? How else will I know that my changes haven't broken the
> > >docs?
> >
> > You can use the web interface of Github and just add/remove/modify a
> > paragraph.
>
> Does Github show a preview? If not, then my question still stands: how
> do I know my changes aren't broken?
>
> If Github does show a preview, then couldn't the reviewer look at that
> too?
>

GitHub provides a "View" button for files while viewing a diff which will
do a basic render for reST files. It won't change all the references like
sealso and such, but basic stuff like literals and links will show up
appropriately.

I think baby steps are probably best here, so getting a zip file as Steve
pointed out to start is still an improvement than the status quo and much
easier to implement.

And any further discussion should probably happen over on core-workflow.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/python-dev/attachments/20181116/3bfd7537/attachment.html>