PyConverter-XML2Py converter.
Project description
A Python wrapper to convert XML documentation into Python source code with its related Sphinx documentation.
Overview
The PyConverter-XML2Py project aims to automatically generate a Python library and a related Sphinx documentation from an XML documentation.
Documentation and issues
On the PyConverter-XML2Py Issues for this repository, you can create issues to submit questions, report bugs, and request new features. To reach the PyAnsys support team, email pyansys.core@ansys.com.
Getting started
Install the pyconverter-xml2py package with:
python -m pip install pyconverter-xml2py
It is recommended to organize the XML documentation as follow:
Converting an XML-directory
Once the XML_directory is correctly organized, the converter can be run.
pyconverter-xml2py package -x XML_directory_path
If some functions need to be customized, the path containing the python files can be specified.
pyconverter-xml2py package -x XML_directory_path -f customized_function_directory_path
A new package is then automatically generated. Its default name is package. It is organized as follow:
Then, the Sphinx documentation can be generated from this package. The following code is to render the documentation as an HTML one from Windows:
cd package
pip install -e .[doc,tests] # Using a virtual environment is recommended.
.\doc\make.bat html
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pyconverter_xml2py-0.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c39b52e72f36c890c85b39675cecf2af2abe173ad4b53c9038e6d27e24b9d93f |
|
MD5 | 15f298837a5f632ceb4536e5a6258b7f |
|
BLAKE2b-256 | d323a5a1d6422295eddafea13db28aeed3d3c040da9878d1e1457e6f67533ec0 |