Trainings by useblocks are containing training materials, demonstrations, access to used source code and free support via e-mail and telephone for the first week after the training.

They can take place on-site for customers in Germany or as an online-meeting using conference tools like MS Teams, Zoom or Jitsi.

Sphinx-Needs Basics

Content

• Create requirements, specifications and test cases
• Setting options
• Creating links
• Usage and filtering of needtable and needflow
• Configuring own need and link types
• Configuring warnings
• Usage of dynamic functions
• Configuring global options together with dynamic functions
• Using builder "needs"
• Usage of needimport

Sphinx-Needs Enterprise (ubCode & ubTrace)

Goals

• Be able to connect Sphinx-Needs to external services like JIRA
• Retrieve information from external services
• Specific filtering of imported, external data
• Steering the activation of Connectors to save external requests
• Usage of a baseline concept with Connectors
• Update objects inside external services

Duration

4 hours

Needed knowledge

• Basic skills of using Sphinx
• Basic skills of using Sphinx-Needs

Content

• Introduction to needservices
• Using needservices for JIRA or other selected services
• Filter and retrieve data from JIRA or other selected services
• Usage of needtable and the filter possibilities for imported data
• Controlling if external services shall be contacted
• Usage of builder "needs" for creating a baseline
• Usage of "sne import" script for creating service specific baselines
• Importing baseline data with the help of needimport
• Usage of basline data and script needs2servie to update external service
  

Sphinx-Needs Development

Goals

• Customize need object representation
• Developing complex filters
• Creating own process logics and automations 
• Synchronising data with company internal services
• Enhance Sphinx-Needs Extensions
• Work with Sphinx-Needs community

Duration

4 hours

Needed knowledge

• Basic skills of using Sphinx
• Deeper knowledge of using Sphinx-Needs

Content

• Create own layout
• Activating layout and styles for specific needs on global rules
• The need data model
• Filter needs for needtable based on Python code
• Creating own dynamic functions
• Creating own needservices
• Usage of Sphinx-Needs API
• Creating a basic Sphinx-Needs extensions
• Python package
• Setup for Sphinx
• Docs and Tests
• Reporting a Bug for Sphinx-Needs
• Understanding roughly the Sphinx-Needs source code
• Creating PRs for Sphinx-Needs
  

Sphinx Trainings

Sphinx Basics

Goals

• Setup Sphinx
• Creating a first project
• Building a project and creating different output formats
• Dealing with files and folders
• Styling text
• Integrate images
• Working with data in tables
• Useful IDE  plugins for just-in-time views
• Activation and usage of Sphinx extensions
• Changing the output design

Duration

4 hours

Needed knowledge

• Basic computer skills
  

Content

• Installation of Python
• Installation of Sphinx
• Using sphinx-quickstart
• Sphinx section and title concept
• Create folders and rst-files
• Register rst-files in toctrees
• Bold, italic text
• The _static and _images folder
• Image and figure directive
• Different table of dealing tables: docutils tables, list-tables, csv-table
• VSCode and PyCharm Plugins for handling sphinx and rst
• Installation and usage of extension Sphinx-Panels
• Installing and configuration of themes
• Own custom.css
  

Sphinx Useful Extensions

Goals

• Support for diagrams
• Support for better text structure
• Showing program output
• Code handling
• Support for requirements and other objects

Duration

4 hours

Needed knowledge

• Basic Sphinx skills

Content

• Usage of Sphinx-PlantUML
• Explaining different diagram types of PlantUML
• Usage of Sphinx-Panels
• Introduction to Sphinx-Programoutput
• Using Sphinx-Autodoc and Python docstring
• Introduction of Sphinx-CopyButton
• Introduction of Sphinx-Needs

Sphinx Extension Development

Goals

• Be able to develop own Sphinx extensions
• Understand Sphinx and docutils internals

Duration

4 hours

Needed knowledge

• Advance user of Sphinx

Content

• Sphinx and doctuils architecture
• Sphinx build workflow
• Sphinx events
• Creating a first own Sphinx directive
• Dealing with docutills nodes
• Defining own roles
• Providing own configuration options
• Create a basic Sphinx builder
• Sphinx Extension best practices
• Builder specific handlers
• Sphinx-Needs API

Contact

Get a customer specific offer for trainings by contacting us.