Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions doc/source/library_description/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,26 @@ from scratch. Therefore, the best practice is to create a Python layer
that maps the raw API into a carefully designed, object oriented data
model and API.


Template
--------
Within the `PyAnsys Organization <https://github.com/pyansys>`_ there
is a `template repository <https://github.com/pyansys/template>`_
where you can `Create a repository from a template`_ and create a new
PyAnsys project that follows the guidelines specified in this guide.

The template repository contains a generalized library skeleton which includes:

- Library skeleton with sample classes and methods.
- Sample documentation build including customized templates.
- Sample GitHub Actions specific to PyAnsys projects.
- Licencing, example readme, and setup file
- ``.gitignore`` and other requirements files.

To use this template, follow the `Create a repository from a
template`_ directions.


.. toctree::
:hidden:
:maxdepth: 3
Expand Down Expand Up @@ -61,3 +81,4 @@ model and API.
.. _grpc_chunk_stream_demo: https://github.com/pyansys/grpc_chunk_stream_demo
.. _numpydoc: https://numpydoc.readthedocs.io/en/latest/format.html
.. _Namespace Packages: https://packaging.python.org/guides/packaging-namespace-packages/
.. _Create a repository from a template: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ this directory structure:

::

.ci/azure-pipelines.yml
.ci/azure-pipelines.yml (optional)
.github/workflows/ci.yml
ansys/
<product/service>/
Expand Down