Testing Projects Module

The test projects used to evaluate exhale.

testing.projects.c_maths Project

The c_maths test project.

testing.projects.c_maths.default_class_hierarchy_dict()[source]

Return the default class hierarchy dictionary.

testing.projects.c_maths.default_file_hierarchy_dict()[source]

Return the default file hierarchy dictionary.

testing.projects.cpp with spaces Project

This cannot be documented because it has spaces in the name and autodoc cannot complete its import.

testing.projects.cpp_fortran_mixed Project

The cpp_fortran_mixed test project.

testing.projects.cpp_fortran_mixed.default_class_hierarchy_dict()[source]

Return the default class hierarchy dictionary.

testing.projects.cpp_fortran_mixed.default_file_hierarchy_dict()[source]

Return the default file hierarchy dictionary.

testing.projects.cpp_func_overloads Project

The cpp_func_overloads test project.

testing.projects.cpp_func_overloads.default_class_hierarchy_dict()[source]

Return the default class hierarchy dictionary.

testing.projects.cpp_func_overloads.default_file_hierarchy_dict()[source]

Return the default file hierarchy dictionary.

testing.projects.cpp_long_names Project

The cpp_long_names test project.

testing.projects.cpp_long_names.RUN_ABSURD_TEST = True

When platform.system() != "Windows", ABSURD_DIRECTORY_PATH is created.

testing.projects.cpp_long_names.make_it_big(prefix)[source]

Mirrors the macro MAKE_IT_BIG in absurdly_long_names.hpp.

testing.projects.cpp_long_names.ABSURD_DIRECTORY_PATH = '/home/docs/checkouts/readthedocs.org/user_builds/exhale/checkouts/latest/testing/projects/cpp_long_names/include/directory/structure/that/is/longer/than/two/hundred/and/fifty/five/characters/long/which/is/an/absolutely/and/completely/ridiculous/thing/to/do/and/if/you/did/this/in/the/real/world/you/put/yourself/comfortably/in/a/position/to/be/downsized/and/outta/here/as/soul/position/would/explain/to/you'

The absurd directory path that will be created depending on RUN_ABSURD_TEST.

testing.projects.cpp_long_names.default_class_hierarchy_dict()[source]

Return the default class hierarchy dictionary.

testing.projects.cpp_long_names.default_file_hierarchy_dict()[source]

Return the default file hierarchy dictionary.

If RUN_ABSURD_TEST is True, ABSURD_DIRECTORY_PATH will be incorporated in the returned dictionary.

testing.projects.cpp_dir_underscores Project

The cpp_dir_underscores test project.

It primarily exists to make sure directories with underscores in their titles get the correct link and title names (since exhale uses underscores internally).

testing.projects.cpp_dir_underscores.default_class_hierarchy_dict()[source]

Return the default class hierarchy dictionar.

testing.projects.cpp_dir_underscores.default_file_hierarchy_dict()[source]

Return the default file hierarchy dictionary.

testing.projects.cpp_nesting Project

The cpp_nesting test project.

testing.projects.cpp_nesting.default_class_hierarchy_dict()[source]

Return the default class hierarchy dictionary.

testing.projects.cpp_nesting.default_file_hierarchy_dict()[source]

Return the default file hierarchy dictionary.

testing.projects.cpp_pimpl Project

The cpp_pimpl test project.

testing.projects.cpp_pimpl.default_class_hierarchy_dict()[source]

Return the default class hierarchy dictionary.

testing.projects.cpp_pimpl.default_file_hierarchy_dict()[source]

Return the default file hierarchy dictionary.