Documentation from source

  • I downloaded the branch from source from the latest release and after I extracted the zip and opened "/docs/sdk/README.html" but the link to further documentation is to a file that does not exist. I was able to find the an online copy at "https://opendxl.github.io/opendxl-client-python/pydoc/" but how do I get it locally?

  • You need to build the distribution.


    To do that, you need to run the following command in the cloned source directory:


    python dist.py


    You also need to have Sphinx installed for the documentation generation. Thus, prior to running the above command install Sphinx via PIP:


    pip install sphinx


    Thanks,

    Chris