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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file pyconverter_xml2py-0.3.0.tar.gz.

File metadata

  • Download URL: pyconverter_xml2py-0.3.0.tar.gz
  • Upload date:
  • Size: 37.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.15

File hashes

Hashes for pyconverter_xml2py-0.3.0.tar.gz
Algorithm Hash digest
SHA256 227586cbfbc4cf5d7d645cf1a8c4b95aaf3d67259fb8613082549788b89f5c87
MD5 83b5fe849258cc36c8aa9e3a0000d880
BLAKE2b-256 65f823c3092c672aed1b6e1960bc41430aaad9986eace80c38a9b28a8bd3e11e

See more details on using hashes here.

File details

Details for the file pyconverter_xml2py-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pyconverter_xml2py-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a0975ac15222d544066b733be952227efceeb8d799a365ba54ca47a02343b849
MD5 6cd46c6f266aa335872a56d97e7aea57
BLAKE2b-256 4395976dd8e530e63caa86b387c257b5e8934ad3f6ee05d73e6f200426153206

See more details on using hashes here.

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