diff --git a/b_asic/save_load_structure.py b/b_asic/save_load_structure.py index 532489ffcfc024e10ac3db7d6ed60a44e1e434c1..2e41999f74c59644f08d5a19fee2a47eae18cda0 100644 --- a/b_asic/save_load_structure.py +++ b/b_asic/save_load_structure.py @@ -1,8 +1,8 @@ """ B-ASIC Save/Load Structure Module. -Contains functions for saving/loading SFGs to/from strings that can be stored -as files. +Contains functions for saving/loading SFGs and Schedules to/from strings that can be +stored as files. """ from datetime import datetime @@ -158,7 +158,7 @@ def python_to_sfg(path: str) -> Tuple[SFG, Dict[str, Tuple[int, int]]]: ) -def schedule_to_python(schedule: Schedule): +def schedule_to_python(schedule: Schedule) -> str: """ Given a schedule structure try to serialize it for saving to a file. diff --git a/docs_sphinx/api/index.rst b/docs_sphinx/api/index.rst index c3480c10839dfe8cc14fc216fc9fed6e18ef85e9..f51f6ce2ee7678be2c5cf1b1d5afd4b6a23b01be 100644 --- a/docs_sphinx/api/index.rst +++ b/docs_sphinx/api/index.rst @@ -11,6 +11,7 @@ API port.rst process.rst resources.rst + save_load_structure.rst schedule.rst sfg_generators.rst signal.rst diff --git a/docs_sphinx/api/save_load_structure.rst b/docs_sphinx/api/save_load_structure.rst new file mode 100644 index 0000000000000000000000000000000000000000..81250dee175b8d60f81aab68e5404de56adbcdbc --- /dev/null +++ b/docs_sphinx/api/save_load_structure.rst @@ -0,0 +1,6 @@ +****************************** +``b_asic.save_load_structure`` +****************************** + +.. automodule:: b_asic.save_load_structure + :members: