Python Ireland September meetup

Introduction to Sphinx & Read the Docs

By: Eric Holscher

Description: This talk will have four parts:

• Why Write Documentation

• Semantic Markup

• Sphinx

• Read the Docs

The beginning of this talk will cover why you should write documentation. Every talk to developers about documentation I feel needs this part, because when you talk about docs people are inherently skeptical. Once people get on board that docs are important, you can cover more interesting concepts.

Then we will walk through the concepts around semantic documentation writing. Similar to Semantic HTML, this allows you to mark up your documentation with metadata that gives you a lot more power and flexibility around the display and authoring of documentation.

Then we’ll have a basic introduction to Sphinx. This will talk about the power that Sphinx gives you to write documentation, and examples of how to use it. We will also cover the semantic power of Sphinx, playing on the previous section to understand it in practice.

Then at last we’ll cover how to host your documentation on Read the Docs. This will make your documentation beautiful with a custom theme, and allow you to host multiple versions and formats of your docs.

Kindly sponsored by Rapid Ratings

http://photos1.meetupstatic.com/photos/event/a/1/c/7/600_454121415.jpeg

Rapid Ratings is the creator of the proprietary FHR® (Financial Health Rating), the industry’s leading assessment of public and private company financial health.

Our disruptive methodology, scalable solutions, and unparalleled support enables businesses to effectively manage and price risks associated with the financial health of third-parties including customers, trading counterparties, suppliers, vendors, and investments.

Hundreds of leading organizations across industry verticals rely on the FHR's® data visualization and detailed reporting tools to provide visibility and early warning of financial deterioration. Rapid Ratings is the only company to rate public and private companies, globally and with the same depth of analysis.

Rapid Ratings is a Fintech disruptor that has developed methodologies to rate any company against millions of data observations to produce real time and predictive ratings which industries are standardizing on for their risk analysis.

Call for Proposals

If you would like to present a talk at a future meetup, please submit your talk proposal at http://python.ie/meetups