Skip to content
BeeWare Docs Tools
2025.8.26.73227.dev1

BeeWare Docs Tools Demo section one: page two

Navigation should render at the bottom of the page; "BeeWare Docs Tools Demo Section One" should be on the left, "Section Two" should be on the right. The footer should be below the navigation links. This confirms the theme configuration has been applied.

Class reference documentation

The following should show the reference documentation for the DocsTest class, located in docs_test.py, in the src/beeware_docs_tools directory. This verifies that the source code directory symlinking is working properly.

Source code in src/beeware_docs_tools/docs_test.py
1
2
3
4
5
6
7
8
class DocsTest:
    def __init__(self):
        """This is the test class."""
        pass

    def attribute(self):
        """This is a test attribute."""
        pass

__init__()

This is the test class.

Source code in src/beeware_docs_tools/docs_test.py
2
3
4
def __init__(self):
    """This is the test class."""
    pass

attribute()

This is a test attribute.

Source code in src/beeware_docs_tools/docs_test.py
6
7
8
def attribute(self):
    """This is a test attribute."""
    pass