PyDita AST converter.
Project description
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 pyansys.core@ansys.com.
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
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 pydita_ast-0.1.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c641b5c8668f730dffc75be8e6f3c20d1eec09d88564e2dc1f01b98ba95b68e2 |
|
MD5 | 84e80e3de400eb5e5f3bc5bcce4a11a2 |
|
BLAKE2b-256 | 661497677037e699a483d78c82353a6a298d496bf0feaccbcb7e104118acd6f2 |