Software documentation with Sphinx

In order for your software package to be useful, documentation is required that describes how your software can be installed, operated, used and improved. For extensive documentation you can use Sphinx, a documentation tool that converts reStructuredText into HTML or PDF, EPub and man pages.

Training objective

You will be able to document your project with Sphinx, whereby code blocks, placeholders, UI elements and interactions are specifically labelled and tables of contents and glossaries are automatically created. Sphinx can also automatically read Python docstrings and create reference documentation from them. Finally, Sphinx can also be extended extensively, so that no wishes shouldremain unfulfilled.

Target group

You work as a technical writer or develop software that needs to be documented quickly and easily.

Course content

Day 1

Create Sphinx project

reStructuredText

Docstrings

Intersphinx

Extensions

What we offer

In our in-house and online seminars, we customise the content exactly to your needs. We coordinate the content with you in advance. We will be happy to provide you with a customised offer.

Your advantages:

📈 Coordinated content:
- ← Introduction to Python
- ← Advanced Python
- ← Design patterns in Python
- → Efficient testing with Python
💁 Personal preliminary discussion
🤝 Customised content
📖 Training documents
📃 Certificate
🧑‍💻 Trainers from the field
🫴 Mentoring and 1:1 coaching

Price:

from €960 (plus VAT)

Veit Schiele
Phone: +49 30 22430082
Send me an e-mail

I will also be happy to call you back!

Enquire now