Skip to main content

PyConverter-XML2Py converter.

Project description

A Python wrapper to convert XML documentation into Python source code with its related Sphinx documentation.

PyAnsys pypi GH-CI codecov MIT black

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:

./doc/source/user_guide/images/diags/graphviz-diag_directory.png

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:

./doc/source/user_guide/images/diags/graphviz-diag_package.png

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyconverter_xml2py-0.3.0.tar.gz (37.7 kB view hashes)

Uploaded Source

Built Distribution

pyconverter_xml2py-0.3.0-py3-none-any.whl (48.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page