Commit f152668e by Alexander Kryklia

Fixes bugs in documentation and improves it.

parent 37cad5dc
*******************************************
Calc
*******************************************
.. automodule:: calc
:members:
:show-inheritance:
...@@ -8,14 +8,6 @@ Contents: ...@@ -8,14 +8,6 @@ Contents:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
chem.rst
Calc
====
.. automodule:: capa.calc
:members:
:show-inheritance:
Capa_problem Capa_problem
============ ============
......
******************************************* *******************************************
Chem module Chemistry modules
******************************************* *******************************************
.. module:: chem .. module:: chem
...@@ -7,7 +7,7 @@ Chem module ...@@ -7,7 +7,7 @@ Chem module
Miller Miller
====== ======
.. automodule:: capa.chem.miller .. automodule:: chem.miller
:members: :members:
:show-inheritance: :show-inheritance:
...@@ -47,14 +47,14 @@ Documentation from **crystallography.js**:: ...@@ -47,14 +47,14 @@ Documentation from **crystallography.js**::
Chemcalc Chemcalc
======== ========
.. automodule:: capa.chem.chemcalc .. automodule:: chem.chemcalc
:members: :members:
:show-inheritance: :show-inheritance:
Chemtools Chemtools
========= =========
.. automodule:: capa.chem.chemtools .. automodule:: chem.chemtools
:members: :members:
:show-inheritance: :show-inheritance:
...@@ -62,7 +62,7 @@ Chemtools ...@@ -62,7 +62,7 @@ Chemtools
Tests Tests
===== =====
.. automodule:: capa.chem.tests .. automodule:: chem.tests
:members: :members:
:show-inheritance: :show-inheritance:
......
...@@ -4,86 +4,3 @@ CMS module ...@@ -4,86 +4,3 @@ CMS module
.. module:: cms .. 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
...@@ -6,4 +6,9 @@ Contents: ...@@ -6,4 +6,9 @@ Contents:
:maxdepth: 2 :maxdepth: 2
xmodule.rst xmodule.rst
capa.rst capa.rst
\ No newline at end of file chem.rst
sandbox-packages.rst
symmath.rst
calc.rst
...@@ -16,20 +16,11 @@ import os ...@@ -16,20 +16,11 @@ import os
# If extensions (or modules to document with autodoc) are in another directory, # 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 # 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. # 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.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 # django configuration - careful here
import os os.environ['DJANGO_SETTINGS_MODULE'] = 'lms.envs.test'
os.environ['DJANGO_SETTINGS_MODULE'] = 'lms.envs.dev'
# -- General configuration ----------------------------------------------------- # -- General configuration -----------------------------------------------------
......
.. MITx documentation master file, created by .. EdX Dev documentation master file, created by
sphinx-quickstart on Fri Nov 2 15:43:00 2012. sphinx-quickstart on Fri Nov 2 15:43:00 2012.
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
Welcome to MITx's documentation! Welcome to EdX's Dev documentation!
================================ ===================================
Contents: Contents:
......
******************************************* *******************************************
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
*******************************************
Sandbox-packages
*******************************************
.. module:: sandbox-packages
Loncapa
=======
.. automodule:: loncapa.loncapa_check
:members:
:show-inheritance:
\ No newline at end of file
*******************************************
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
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment