We introduce a new documentation target, where we use the featuretoggles Sphinx extension from code-annotations to generate human-readable documentation of feature toggles in edx-platform. The annotation report is generated on-the-fly based on the standard feature toggle configuration file in code-annotations. In addition, we add new doc.in & doc.txt requirement files that will be pip-installed by readthedocs to generate the documentation targets.
8 lines
303 B
Plaintext
8 lines
303 B
Plaintext
# Requirements for documentation validation
|
|
-c ../constraints.txt
|
|
|
|
code-annotations # provides annotations for certain documentation
|
|
edx_sphinx_theme # edX theme for Sphinx output
|
|
gitpython # fetch git repo information
|
|
Sphinx # Documentation builder
|