diff --git a/docs/API_Reference.rst b/docs/API_Reference.rst new file mode 100644 index 0000000..8dd46bd --- /dev/null +++ b/docs/API_Reference.rst @@ -0,0 +1,7 @@ +API Reference +============= + +.. automodule:: sbol2build.sbol2build + :members: + :undoc-members: + :show-inheritance: \ No newline at end of file diff --git a/docs/Installation.rst b/docs/Installation.rst new file mode 100644 index 0000000..dbc9b80 --- /dev/null +++ b/docs/Installation.rst @@ -0,0 +1,2 @@ +Installation +====================================== \ No newline at end of file diff --git a/docs/Tutorials.rst b/docs/Tutorials.rst new file mode 100644 index 0000000..8da6e92 --- /dev/null +++ b/docs/Tutorials.rst @@ -0,0 +1,3 @@ +Tutorials +====================================== +Let's get started with creating DNA assembly plans. First we will demonstrate a workflow using plasmid files from `SBOLCanvas `_: \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index cfa05fb..ea066a8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -30,3 +30,10 @@ html_theme = 'furo' html_static_path = ['_static'] + +html_theme_options = { + "light_css_variables": {}, + "dark_css_variables": {}, + "default_color_mode": "light", + "color_mode_toggle": True, +} \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 27318e0..225bc38 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,12 +14,10 @@ It was developed to support build functionality and workflows in `SynBioSuite List[Tuple[sbol2.ComponentDefinition, sbol2.Sequence]]: + """Runs full assembly simulation. + `document` parameter of golden_gate_assembly_plan object is updated by reference to include assembly plan ModuleDefinition and all related information. + + Runs :func:`part_digestion` for all `parts_in_backbone` and :func:`backbone_digestion` for `plasmid_acceptor_backbone` with `restriction_enzyme`. Then runs :func:`ligation` with these parts to form composites. + :return: List of all composites generated, in the form of tuples of ComponentDefinition and Sequence. """ for part_doc in self.parts_in_backbone: