pydita-ast 0.1.0

PyDita AST converter.

A Python wrapper to convert XML documentation into RST files and the Sphinx documentation.

Overview

The PyDita-AST project aims to automatically generate a Python library and a related Sphinx documentation from an XML documentation.

Documentation and issues

On the PyDita-AST Issues for this repository, you can create issues to submit questions, report bugs, and request new features. To reach the PyAnsys support team, email [e-mail].

Getting started

Install the pydita-ast package with:

python -m pip install pydita-ast

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.

python xml2rst.py -p XML_directory_path

If some functions need to be customized, the path containing the python files can be specified.

python xml2rst.py -p 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