Adding download module documentation (#129)

Co-authored-by: Roberto Pastor Muela <[email protected]>
ansys · Sep 7, 2023 · 9a126ac · 9a126ac
1 parent a2737cf
commit 9a126ac
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/doc/source/api/download.rst b/doc/source/api/download.rst
@@ -0,0 +1,14 @@
+Download
+========
+
+.. currentmodule:: pyconverter.xml2py.download
+
+The following functions enable to download the `_package` folder
+from the `GitHub repository <pyconverter.xml2py_gh_>`_.
+
+.. autosummary::
+   :toctree: _autosummary/writer
+
+   download
+   download_folder
+   download_template
diff --git a/doc/source/links.rst b/doc/source/links.rst
@@ -5,6 +5,7 @@
 .. _pyansys_core: [email protected]
 
 .. #PyConverter-XML2Py related
+.. _pyconverter.xml2py_gh: https://github.com/ansys/pyconverter-xml2py
 .. _pyconverter.xml2py_issues: https://github.com/ansys/pyconverter-xml2py/issues
 
 .. #PyAnsys Developer Guide

diff --git a/doc/styles/Vocab/ANSYS/accept.txt b/doc/styles/Vocab/ANSYS/accept.txt
@@ -12,3 +12,4 @@ AST
 pytest
 venv
 XML_directory
+_package