diff --git a/docs/en_us/developers/source/common-lib.rst b/docs/en_us/developers/source/common-lib.rst index f691a83ed2..1cdae8c76b 100644 --- a/docs/en_us/developers/source/common-lib.rst +++ b/docs/en_us/developers/source/common-lib.rst @@ -6,6 +6,7 @@ Contents: :maxdepth: 2 xmodule.rst + modulestore.rst capa.rst chem.rst sandbox-packages.rst diff --git a/docs/en_us/developers/source/modulestore.rst b/docs/en_us/developers/source/modulestore.rst new file mode 100644 index 0000000000..596af8fe7b --- /dev/null +++ b/docs/en_us/developers/source/modulestore.rst @@ -0,0 +1,110 @@ +******************************************* +Xmodule.Modulestore +******************************************* + +.. contents:: Table of Contents + +.. automodule:: xmodule.modulestore + :members: + :show-inheritance: + +Modulestores +============ + +These implement the :class:`.ModuleStoreRead` and :class:`.ModuleStoreWrite` +to provide access to XBlock content. + +.. automodule:: xmodule.modulestore.xml + :members: + :show-inheritance: + +.. automodule:: xmodule.modulestore.mongo + :members: + :show-inheritance: + +.. automodule:: xmodule.modulestore.split_mongo + :members: + :show-inheritance: + + +Modulestore Helpers +------------------- + +These packages provide utilities for easier use of modulestores, +and migrating data between modulestores. + +.. automodule:: xmodule.modulestore.loc_mapper_store + :members: + :show-inheritance: + +.. automodule:: xmodule.modulestore.search + :members: + :show-inheritance: + +.. automodule:: xmodule.modulestore.mongoengine_fields + :members: + :show-inheritance: + +.. automodule:: xmodule.modulestore.split_migrator + :members: + :show-inheritance: + +.. automodule:: xmodule.modulestore.store_utilities + :members: + :show-inheritance: + + + +Content Keys +============ + +These packages provide the definition of the key types that are +used in the modulestores to address content, and definitions of +key types. + +.. automodule:: xmodule.modulestore.keys + :members: + :show-inheritance: + +.. automodule:: xmodule.modulestore.locations + :members: + :show-inheritance: + +.. automodule:: xmodule.modulestore.locator + :members: + :show-inheritance: + + + +Xml Import/Export +================= + +These packages focus on importing and exporting xml serialized +course content to/from modulestores. + +.. automodule:: xmodule.modulestore.xml_exporter + :members: + :show-inheritance: + +.. automodule:: xmodule.modulestore.xml_importer + :members: + :show-inheritance: + + + +Miscellaneous +============= + +.. automodule:: xmodule.modulestore.django + :members: + :show-inheritance: + +.. automodule:: xmodule.modulestore.exceptions + :members: + :show-inheritance: + +.. automodule:: xmodule.modulestore.inheritance + :members: + :show-inheritance: + +