Skip to content

Commit 3a43759

Browse files
authored
note template usage (#12)
1 parent 335b313 commit 3a43759

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

doc/source/library_description/index.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,26 @@ from scratch. Therefore, the best practice is to create a Python layer
3333
that maps the raw API into a carefully designed, object oriented data
3434
model and API.
3535

36+
37+
Template
38+
--------
39+
Within the `PyAnsys Organization <https://github.com/pyansys>`_ there
40+
is a `template repository <https://github.com/pyansys/template>`_
41+
where you can `Create a repository from a template`_ and create a new
42+
PyAnsys project that follows the guidelines specified in this guide.
43+
44+
The template repository contains a generalized library skeleton which includes:
45+
46+
- Library skeleton with sample classes and methods.
47+
- Sample documentation build including customized templates.
48+
- Sample GitHub Actions specific to PyAnsys projects.
49+
- Licencing, example readme, and setup file
50+
- ``.gitignore`` and other requirements files.
51+
52+
To use this template, follow the `Create a repository from a
53+
template`_ directions.
54+
55+
3656
.. toctree::
3757
:hidden:
3858
:maxdepth: 3
@@ -61,3 +81,4 @@ model and API.
6181
.. _grpc_chunk_stream_demo: https://github.com/pyansys/grpc_chunk_stream_demo
6282
.. _numpydoc: https://numpydoc.readthedocs.io/en/latest/format.html
6383
.. _Namespace Packages: https://packaging.python.org/guides/packaging-namespace-packages/
84+
.. _Create a repository from a template: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template

doc/source/library_description/repo_directory_structure.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ this directory structure:
88

99
::
1010

11-
.ci/azure-pipelines.yml
11+
.ci/azure-pipelines.yml (optional)
1212
.github/workflows/ci.yml
1313
ansys/
1414
<product/service>/

0 commit comments

Comments
 (0)