[Python-authors] Python-authors Digest, Vol 26, Issue 2

Doug Hellmann doug at doughellmann.com
Mon Feb 24 17:09:51 CET 2014 

I put the code in separate files from the reST and then use cog with sphinx to run the scripts and insert the output. That lets me commit the output to source control with the rest of the document, to catch changes between builds (I found a regression in a Python standard library module that way while working on PyMOTW).

http://doughellmann.com/2009/02/02/writing-technical-documentation-with-sphinx-paver-and-cog.html

https://bitbucket.org/dhellmann/sphinxcontrib-paverutils

Doug

On Feb 23, 2014, at 8:09 PM, Varied Thoughts <variedthoughts at gmail.com> wrote:

> Hi all,
> I'm just about to put my first draft into some structure. 
> It's in markdown-ish. 
> I'd like to know more about the test scripts used. 
> 
> What are people using?
> 
> Do you insert code an output into doc during make?
> Or extract code out of markdown somehow to run and test?
> Are you inserting the output into the doc?
> Or comparing the real output with the output listed in markdown doc?
> 
> I know, ... So many questions. 
> 
> Regards,
> Brian Okken
> 
> 
>> On Feb 23, 2014, at 3:00 AM, python-authors-request at python.org wrote:
>> 
>> Send Python-authors mailing list submissions to
>>   python-authors at python.org
>> 
>> To subscribe or unsubscribe via the World Wide Web, visit
>>   https://mail.python.org/mailman/listinfo/python-authors
>> or, via email, send a message with subject or body 'help' to
>>   python-authors-request at python.org
>> 
>> You can reach the person managing the list at
>>   python-authors-owner at python.org
>> 
>> When replying, please edit your Subject line so it is more specific
>> than "Re: Contents of Python-authors digest..."
>> 
>> 
>> Today's Topics:
>> 
>>  1. Re: Python 101 - the book (Doug Hellmann)
>>  2. Re: Python 101 - the book (Mike Driscoll)
>>  3. Re: Python 101 - the book (wesley chun)
>> 
>> 
>> ----------------------------------------------------------------------
>> 
>> Message: 1
>> Date: Sat, 22 Feb 2014 10:55:23 -0500
>> From: Doug Hellmann <doug at doughellmann.com>
>> To: Python Authors <python-authors at python.org>
>> Subject: Re: [Python-authors] Python 101 - the book
>> Message-ID: <9062A87B-8811-448F-9262-4A52A9DFB715 at doughellmann.com>
>> Content-Type: text/plain; charset="windows-1252"
>> 
>> What a great idea! I hope you?ll blog about your progress.
>> 
>> Doug
>> 
>>> On Feb 19, 2014, at 10:56 AM, Mike Driscoll <mike at pythonlibrary.org> wrote:
>>> 
>>> Hi,
>>> 
>>> I've mentioned I'm working on a book on this list a few times. Well I've gotten over a dozen chapters written and I've started a Kickstarter for the project that I thought I'd share:
>>> 
>>> http://kck.st/1kX98BB
>>> 
>>> Authoring a book is a lot of fun and a lot of work. Thanks for all the help you all have given me! 
>>> 
>>> Mike
>>> 
>>> P.S. I may ask more questions later!
>>> _______________________________________________
>>> Python-authors mailing list
>>> Python-authors at python.org
>>> https://mail.python.org/mailman/listinfo/python-authors
>> 
>> -------------- next part --------------
>> An HTML attachment was scrubbed...
>> URL: <http://mail.python.org/pipermail/python-authors/attachments/20140222/c75cb666/attachment-0001.html>
>> 
>> ------------------------------
>> 
>> Message: 2
>> Date: Sat, 22 Feb 2014 11:10:09 -0600
>> From: Mike Driscoll <mike at pythonlibrary.org>
>> Cc: Python Authors <python-authors at python.org>
>> Subject: Re: [Python-authors] Python 101 - the book
>> Message-ID:
>>   <CAO4gEAvKzxa7rC4jZE3JBdMhjfFMzgsHGc8QJfBwG4tgQUQaOg at mail.gmail.com>
>> Content-Type: text/plain; charset="iso-8859-1"
>> 
>> Hi Doug,
>> 
>> I'm not only going to blog about the progress, but also about the process
>> itself. There isn't enough information out there about how to write books
>> using Python tools.
>> 
>> - Mike
>> 
>> 
>> On Sat, Feb 22, 2014 at 9:55 AM, Doug Hellmann <doug at doughellmann.com>wrote:
>> 
>>> What a great idea! I hope you'll blog about your progress.
>>> 
>>> Doug
>>> 
>>> On Feb 19, 2014, at 10:56 AM, Mike Driscoll <mike at pythonlibrary.org>
>>> wrote:
>>> 
>>> Hi,
>>> 
>>> I've mentioned I'm working on a book on this list a few times. Well I've
>>> gotten over a dozen chapters written and I've started a Kickstarter for the
>>> project that I thought I'd share:
>>> 
>>> http://kck.st/1kX98BB
>>> 
>>> Authoring a book is a lot of fun and a lot of work. Thanks for all the
>>> help you all have given me!
>>> 
>>> Mike
>>> 
>>> P.S. I may ask more questions later!
>>> _______________________________________________
>>> Python-authors mailing list
>>> Python-authors at python.org
>>> https://mail.python.org/mailman/listinfo/python-authors
>>> 
>>> 
>>> 
>>> _______________________________________________
>>> Python-authors mailing list
>>> Python-authors at python.org
>>> https://mail.python.org/mailman/listinfo/python-authors
>> 
>> 
>> -- 
>> -----------------
>> Mike Driscoll
>> 
>> Blog:   http://blog.pythonlibrary.org
>> -------------- next part --------------
>> An HTML attachment was scrubbed...
>> URL: <http://mail.python.org/pipermail/python-authors/attachments/20140222/e1da2eb7/attachment-0001.html>
>> 
>> ------------------------------
>> 
>> Message: 3
>> Date: Sat, 22 Feb 2014 11:00:45 -0800
>> From: wesley chun <wescpy at gmail.com>
>> To: Mike Driscoll <mike at pythonlibrary.org>
>> Cc: Python Authors <python-authors at python.org>
>> Subject: Re: [Python-authors] Python 101 - the book
>> Message-ID:
>>   <CAB6eaA6MGQCm_dtRrnvEsinT-2XGYcHRarXbCSZMFx9qm9dz-Q at mail.gmail.com>
>> Content-Type: text/plain; charset="iso-8859-1"
>> 
>> i did one years ago:
>> 
>>  - EuroPython 2011 talk description +
>> video<https://ep2013.europython.eu/conference/talks/writing-books-using-python-open-source-software>
>>  - OSCON 2009 slide
>> deck<http://cdn.oreillystatic.com/en/assets/1/event/27/Writing%20Books%20using%20Open%20Source%20Software%20Presentation.pdf>
>> 
>> cheers, and good luck!
>> --wesley
>> 
>> 
>> On Sat, Feb 22, 2014 at 9:10 AM, Mike Driscoll <mike at pythonlibrary.org>wrote:
>> 
>>> Hi Doug,
>>> 
>>> I'm not only going to blog about the progress, but also about the process
>>> itself. There isn't enough information out there about how to write books
>>> using Python tools.
>>> 
>>> - Mike
>>> 
>>> 
>>> On Sat, Feb 22, 2014 at 9:55 AM, Doug Hellmann <doug at doughellmann.com>wrote:
>>> 
>>>> What a great idea! I hope you'll blog about your progress.
>>>> 
>>>> Doug
>>>> 
>>>> On Feb 19, 2014, at 10:56 AM, Mike Driscoll <mike at pythonlibrary.org>
>>>> wrote:
>>>> 
>>>> Hi,
>>>> 
>>>> I've mentioned I'm working on a book on this list a few times. Well I've
>>>> gotten over a dozen chapters written and I've started a Kickstarter for the
>>>> project that I thought I'd share:
>>>> 
>>>> http://kck.st/1kX98BB
>>>> 
>>>> Authoring a book is a lot of fun and a lot of work. Thanks for all the
>>>> help you all have given me!
>>>> 
>>>> Mike
>>>> 
>>>> P.S. I may ask more questions later!
>>>> _______________________________________________
>>>> Python-authors mailing list
>>>> Python-authors at python.org
>>>> https://mail.python.org/mailman/listinfo/python-authors
>>>> 
>>>> 
>>>> 
>>>> _______________________________________________
>>>> Python-authors mailing list
>>>> Python-authors at python.org
>>>> https://mail.python.org/mailman/listinfo/python-authors
>>> 
>>> 
>>> --
>>> -----------------
>>> Mike Driscoll
>>> 
>>> Blog:   http://blog.pythonlibrary.org
>>> 
>>> _______________________________________________
>>> Python-authors mailing list
>>> Python-authors at python.org
>>> https://mail.python.org/mailman/listinfo/python-authors
>> 
>> 
>> -- 
>> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
>> "A computer never does what you want... only what you tell it."
>>   +wesley chun <http://google.com/+WesleyChun> : wescpy at gmail :
>> @wescpy<http://twitter.com/wescpy>
>>   Python training & consulting : http://CyberwebConsulting.com
>>   "Core Python" books : http://CorePython.com
>>   Python blog: http://wescpy.blogspot.com
>> -------------- next part --------------
>> An HTML attachment was scrubbed...
>> URL: <http://mail.python.org/pipermail/python-authors/attachments/20140222/179df915/attachment-0001.html>
>> 
>> ------------------------------
>> 
>> Subject: Digest Footer
>> 
>> _______________________________________________
>> Python-authors mailing list
>> Python-authors at python.org
>> https://mail.python.org/mailman/listinfo/python-authors
>> 
>> 
>> ------------------------------
>> 
>> End of Python-authors Digest, Vol 26, Issue 2
>> *********************************************
> _______________________________________________
> Python-authors mailing list
> Python-authors at python.org
> https://mail.python.org/mailman/listinfo/python-authors

More information about the Python-authors mailing list