From 0bfca4cb91907a183779f8f8cc09169b9815f4e0 Mon Sep 17 00:00:00 2001 From: Alex Kaszynski Date: Thu, 16 Sep 2021 10:46:26 -0600 Subject: [PATCH] note template usage --- doc/source/library_description/index.rst | 21 +++++++++++++++++++ .../repo_directory_structure.rst | 2 +- 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/doc/source/library_description/index.rst b/doc/source/library_description/index.rst index fc6076861..8d3429058 100644 --- a/doc/source/library_description/index.rst +++ b/doc/source/library_description/index.rst @@ -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 `_ there +is a `template repository `_ +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 @@ -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 diff --git a/doc/source/library_description/repo_directory_structure.rst b/doc/source/library_description/repo_directory_structure.rst index 7e217b3af..dc333cc61 100644 --- a/doc/source/library_description/repo_directory_structure.rst +++ b/doc/source/library_description/repo_directory_structure.rst @@ -8,7 +8,7 @@ this directory structure: :: - .ci/azure-pipelines.yml + .ci/azure-pipelines.yml (optional) .github/workflows/ci.yml ansys/ /