This docker image provides an easy way to extract python documentation in xml format from python modules.
It only needs a setup script to install the needed packages and an index.rst
to define the desired output.
docker pull blang/sphinx-xml-extract
# OR build by yourself
docker build -t blang/sphinx-xml-extract .
pip install matplotlib
.. automodule:: matplotlib.pyplot
:members:
:undoc-members:
:show-inheritance:
Mount /data/output
, that's where the generated index.xml
will be placed.
Mount /data/input
, containing setup.sh
and index.rst
docker run -i -t -v /tmp/output:/data/output -v $PWD:/data/input:ro blang/sphinx-xml-extract