Using Sphinx for Python docs

[Fei Min Lorente]

“Cheers for a great tool that actually makes programmers want to write documentation!”

Lots of software developers write Python scripts or C/C++ programs. Did you know they could write the documentation there, too? Just think of the benefits:

• When they change the code, they'll update the documentation because it's right there.
• Code snippets can be automatically tested.
• You reap all the benefits of having your documentation in text format, such as being able to manipulate the content with scripts, or taking full advantage of your company's version control system.

Even if you think you'll never work anywhere that has documentation embedded in the code, it's interesting to see the rewards and challenges of this situation. It might be more applicable than you think!

For more information about this free session, see Using Sphinx for Python docs on the Southwestern Ontario Chapter website.

Fei Min Lorente

Volunteer Co-ordinator

STC Southwestern Ontario Chapter

[DARLENE WOOD]

Hi:

I'd like to come to this meeting, but I can't seem to sign up.
I clicked the link.
I clicked Join Us.
I logged into Meetups.
I didn't see this session listed anywhere.

-Darlene Wood
--------------------------------------------
On Wed, 5/4/16, Fei Min Lorente <feimin....@gmail.com> wrote:

Subject: [STC-SOC:324] Using Sphinx for Python docs
To: "stc-southwes...@googlegroups.com" <stc-southwes...@googlegroups.com>
Date: Wednesday, May 4, 2016, 9:07 PM

“Cheers
for a great tool that actually makes programmers want to
write documentation!”

Lots of software developers write Python scripts
or C/C++ programs. Did you know they could write the
documentation there, too? Just think of the
benefits:When they change the code,
they'll update the documentation because it's right
there.Code snippets can be automatically

tested.You reap all the benefits of having your

documentation in text format, such as being able to
manipulate the content with scripts, or taking full
advantage of your company's version control

system.Even if you think you'll never

work anywhere that has documentation embedded in the code,
it's interesting to see the rewards and challenges of
this situation. It might be more applicable than you
think!
For more information about this free session, see
Using
Sphinx for Python docs on the Southwestern Ontario
Chapter website.
Fei Min LorenteVolunteer
Co-ordinatorSTC Southwestern Ontario
Chapter

--

--

You received this message because you are subscribed to the
Google Groups "STC Southwestern Ontario".

To post to this group, send email to
stc-southwes...@googlegroups.com

To unsubscribe from this group, send email to
stc-southwestern-o...@googlegroups.com

To change your personal settings, visit this group at http://groups.google.com/group/stc-southwestern-ontario?hl=en?hl=en

 

Privacy Statement

The STC Southwestern Ontario Chapter (STC-SOC) will not
sell, rent, or give away your email address to any outside
party. This list is strictly for discussing technical
communication issues and announcing technical communication
news and events. If you do not wish to receive STC-SOC
emails, please send an email to
stc-southwestern-o...@googlegroups.com.



---

You received this message because you are subscribed to the
Google Groups "STC Southwestern Ontario" group.

To unsubscribe from this group and stop receiving emails
from it, send an email to stc-southwestern-o...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

[Fei Min Lorente]

Hi Darlene:

Try this link: http://www.meetup.com/Technical-Communication-P2P/events/230536869/

Fei Min

[DARLENE WOOD]

ok, I did.
I logged in and clicked RSVP, but then don't know what to do next. There's no button to say COMING or whatever.