Sphinx Using GitHub Actions Demo documentation

This is just a simple demo of automatically updating and hosting Sphinx documentation on GitHub.

hello.py

This is an example file with correct docstring examples

Author: Seth McNeill

Date: 2025 September 07

class hello.SayHello(name)

Bases: object

Base class example

This class provides an example to work from

Parameters:

name (str) – The user’s name

name

The user’s name

Type:

str

Examples

>>> hello = SayHello("Bob")
>>> hello.greet(', welcome!')
Hello Bob, welcome!

greet(extraText)

Greets self.name and adds extraText to the output.

Parameters:

extraText (str) – Text to add after the hello username

Returns:

An integer as an example of returning a value

Return type:

int