diff --git a/docs/source/calc.rst b/docs/source/calc.rst new file mode 100644 index 0000000000..659ebc11d7 --- /dev/null +++ b/docs/source/calc.rst @@ -0,0 +1,7 @@ +******************************************* +Calc +******************************************* + +.. automodule:: calc + :members: + :show-inheritance: diff --git a/docs/source/capa.rst b/docs/source/capa.rst index 345855af5e..be828ba33a 100644 --- a/docs/source/capa.rst +++ b/docs/source/capa.rst @@ -8,14 +8,6 @@ Contents: .. toctree:: :maxdepth: 2 - chem.rst - -Calc -==== - -.. automodule:: capa.calc - :members: - :show-inheritance: Capa_problem ============ diff --git a/docs/source/chem.rst b/docs/source/chem.rst index 26e01a3238..025c436d37 100644 --- a/docs/source/chem.rst +++ b/docs/source/chem.rst @@ -1,5 +1,5 @@ ******************************************* -Chem module +Chemistry modules ******************************************* .. module:: chem @@ -7,7 +7,7 @@ Chem module Miller ====== -.. automodule:: capa.chem.miller +.. automodule:: chem.miller :members: :show-inheritance: @@ -47,14 +47,14 @@ Documentation from **crystallography.js**:: Chemcalc ======== -.. automodule:: capa.chem.chemcalc +.. automodule:: chem.chemcalc :members: :show-inheritance: Chemtools ========= -.. automodule:: capa.chem.chemtools +.. automodule:: chem.chemtools :members: :show-inheritance: @@ -62,7 +62,7 @@ Chemtools Tests ===== -.. automodule:: capa.chem.tests +.. automodule:: chem.tests :members: :show-inheritance: diff --git a/docs/source/cms.rst b/docs/source/cms.rst index 02dcaccb5a..11fa243f90 100644 --- a/docs/source/cms.rst +++ b/docs/source/cms.rst @@ -4,86 +4,3 @@ CMS module .. module:: cms -Auth -==== - -.. automodule:: auth - :members: - :show-inheritance: - -Authz ------ - -.. automodule:: auth.authz - :members: - :show-inheritance: - -Content store -============= - -.. .. automodule:: contentstore -.. :members: -.. :show-inheritance: - -.. Utils -.. ----- - -.. .. automodule:: contentstore.untils -.. :members: -.. :show-inheritance: - -.. Views -.. ----- - -.. .. automodule:: contentstore.views -.. :members: -.. :show-inheritance: - -.. Management -.. ---------- - -.. .. automodule:: contentstore.management -.. :members: -.. :show-inheritance: - -.. Tests -.. ----- - -.. .. automodule:: contentstore.tests -.. :members: -.. :show-inheritance: - -Github sync -=========== - -.. automodule:: github_sync - :members: - :show-inheritance: - -Exceptions ----------- - -.. automodule:: github_sync.exceptions - :members: - :show-inheritance: - -Views ------ - -.. automodule:: github_sync.views - :members: - :show-inheritance: - -Management ----------- - -.. automodule:: github_sync.management - :members: - :show-inheritance: - -Tests ------ - -.. .. automodule:: github_sync.tests -.. :members: -.. :show-inheritance: \ No newline at end of file diff --git a/docs/source/common-lib.rst b/docs/source/common-lib.rst index 4fa5eaeb0a..2079ae7a23 100644 --- a/docs/source/common-lib.rst +++ b/docs/source/common-lib.rst @@ -6,4 +6,9 @@ Contents: :maxdepth: 2 xmodule.rst - capa.rst \ No newline at end of file + capa.rst + chem.rst + sandbox-packages.rst + symmath.rst + calc.rst + diff --git a/docs/source/conf.py b/docs/source/conf.py index 0efe03568c..8c49dec851 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -16,20 +16,11 @@ import os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath('.')) +# sys.path.insert(0, os.path.abspath('.')) sys.path.insert(0, os.path.abspath('../..')) # mitx folder -sys.path.insert(0, os.path.join(os.path.abspath('../..'), 'common', 'lib', 'calc')) # calc module -sys.path.insert(0, os.path.join(os.path.abspath('../..'), 'common', 'lib', 'chem')) # calc module -sys.path.insert(0, os.path.join(os.path.abspath('../..'), 'common', 'lib', 'sandbox-packages')) # calc module -sys.path.insert(0, os.path.join(os.path.abspath('../..'), 'common', 'lib', 'capa')) # capa module -sys.path.insert(0, os.path.join(os.path.abspath('../..'), 'common', 'lib', 'xmodule')) # xmodule -sys.path.insert(0, os.path.join(os.path.abspath('../..'), 'lms', 'djangoapps')) # lms djangoapps -sys.path.insert(0, os.path.join(os.path.abspath('../..'), 'cms', 'djangoapps')) # cms djangoapps -sys.path.insert(0, os.path.join(os.path.abspath('../..'), 'common', 'djangoapps')) # common djangoapps # django configuration - careful here -import os -os.environ['DJANGO_SETTINGS_MODULE'] = 'lms.envs.dev' +os.environ['DJANGO_SETTINGS_MODULE'] = 'lms.envs.test' # -- General configuration ----------------------------------------------------- diff --git a/docs/source/index.rst b/docs/source/index.rst index eceb5e23e8..780bc55049 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,10 +1,10 @@ -.. MITx documentation master file, created by +.. EdX Dev documentation master file, created by sphinx-quickstart on Fri Nov 2 15:43:00 2012. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to MITx's documentation! -================================ +Welcome to EdX's Dev documentation! +=================================== Contents: diff --git a/docs/source/overview.rst b/docs/source/overview.rst index 007c7582ad..a6d71cbd88 100644 --- a/docs/source/overview.rst +++ b/docs/source/overview.rst @@ -1,20 +1,9 @@ ******************************************* -What the pieces are? +Overview ******************************************* -What -==== -... +This is EdX Dev documentation, mainly extracted from docstrings. +Autogenerated by Sphinx from python code. +Soon support for JS will be impemented. -How -=== - -... - - -Who -=== - - -... \ No newline at end of file diff --git a/docs/source/sandbox-packages.rst b/docs/source/sandbox-packages.rst new file mode 100644 index 0000000000..f63c99c6aa --- /dev/null +++ b/docs/source/sandbox-packages.rst @@ -0,0 +1,11 @@ +******************************************* +Sandbox-packages +******************************************* +.. module:: sandbox-packages + +Loncapa +======= + +.. automodule:: loncapa.loncapa_check + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/symmath.rst b/docs/source/symmath.rst new file mode 100644 index 0000000000..7664e8ac6e --- /dev/null +++ b/docs/source/symmath.rst @@ -0,0 +1,31 @@ +******************************************* +Symmath +******************************************* + +.. module:: symmath + + +Formula +======= + +.. automodule:: symmath.formula + :members: + :show-inheritance: + +Symmath check +============= + +.. automodule:: symmath.symmath_check + :members: + :show-inheritance: + +Symmath tests +============= + +.. automodule:: symmath.test_formula + :members: + :show-inheritance: + +.. automodule:: symmath.test_symmath_check + :members: + :show-inheritance: \ No newline at end of file