DOC: update development documentation 2ed6a90

ansys · Sep 4, 2023 · ca81ff9 · ca81ff9
commit ca81ff9
Show file tree

Hide file tree

Showing 222 changed files with 25,636 additions and 0 deletions.
diff --git a/.nojekyll b/.nojekyll
diff --git a/CNAME b/CNAME
@@ -0,0 +1 @@
+pre-commit-hooks.docs.ansys.com
diff --git a/index.html b/index.html
@@ -0,0 +1,6 @@
+<!DOCTYPE html>
+<meta charset="utf-8">
+<title>Redirecting to https://pre-commit-hooks.docs.ansys.com/version/stable/</title>
+<meta name="description" content="">
+<meta http-equiv="refresh" content="0; URL=https://pre-commit-hooks.docs.ansys.com/version/stable/">
+<link rel="canonical" href="https://pre-commit-hooks.docs.ansys.com/version/stable/">
diff --git a/sitemap.xml b/sitemap.xml
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+  <url>
+    <loc>https://www.pre-commit-hooks.docs.ansys.com</loc>
+    <lastmod>2023-09-01T13:01:51+00:00</lastmod>
+    <changefreq>daily</changefreq>
+    <priority>1.0</priority>
+  </url>
+  <url>
+    <loc>https://www.pre-commit-hooks.docs.ansys.com/autoapi/index</loc>
+    <lastmod>2023-09-01T13:01:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://www.pre-commit-hooks.docs.ansys.com/autoapi/pre_commit_hooks/add_license_headers/index</loc>
+    <lastmod>2023-09-01T13:01:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://www.pre-commit-hooks.docs.ansys.com/autoapi/pre_commit_hooks/index</loc>
+    <lastmod>2023-09-01T13:01:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://www.pre-commit-hooks.docs.ansys.com/_static/webpack-macros</loc>
+    <lastmod>2023-09-01T13:01:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://www.pre-commit-hooks.docs.ansys.com/search</loc>
+    <lastmod>2023-09-01T13:01:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://www.pre-commit-hooks.docs.ansys.com/genindex</loc>
+    <lastmod>2023-09-01T13:01:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://www.pre-commit-hooks.docs.ansys.com/index</loc>
+    <lastmod>2023-09-01T13:01:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://www.pre-commit-hooks.docs.ansys.com/py-modindex</loc>
+    <lastmod>2023-09-01T13:01:51+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+</urlset>
diff --git a/version/0.1/.buildinfo b/version/0.1/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: bcdb4b438276f1038db0ddafe532b6cc
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/version/0.1/_sources/autoapi/index.rst.txt b/version/0.1/_sources/autoapi/index.rst.txt
@@ -0,0 +1,9 @@
+API reference
+=============
+
+This section provides descriptions of all API members for Ansys pre-commit hooks.
+
+.. toctree::
+   :titlesonly:
+
+   /autoapi/pre_commit_hooks/index
diff --git a/version/0.1/_sources/autoapi/pre_commit_hooks/add_license_headers/index.rst.txt b/version/0.1/_sources/autoapi/pre_commit_hooks/add_license_headers/index.rst.txt
@@ -0,0 +1,225 @@
+:py:mod:`pre_commit_hooks.add_license_headers`
+==============================================
+
+.. py:module:: pre_commit_hooks.add_license_headers
+
+.. autoapi-nested-parse::
+
+   Module for running `REUSE <https://reuse.software/>`_ to add missing license headers to files.
+
+   A license header consists of the Ansys copyright statement and licensing information.
+
+   ..
+       !! processed by numpydoc !!
+
+
+Module Contents
+---------------
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   pre_commit_hooks.add_license_headers.set_lint_args
+   pre_commit_hooks.add_license_headers.list_noncompliant_files
+   pre_commit_hooks.add_license_headers.find_files_missing_header
+   pre_commit_hooks.add_license_headers.check_reuse_dir
+   pre_commit_hooks.add_license_headers.run_reuse
+   pre_commit_hooks.add_license_headers.main
+
+
+
+.. py:function:: set_lint_args(parser)
+
+   
+   Add lint arguments to the parser for `REUSE <https://reuse.software/>`_.
+
+
+   :Parameters:
+
+       **parser: argparse.ArgumentParser**
+           Parser without any lint arguments.
+
+   :Returns:
+
+       :obj:`argparse.Namespace`
+           Parser namespace containing lint arguments.
+
+
+
+
+
+
+
+
+
+
+
+
+
+   ..
+       !! processed by numpydoc !!
+
+.. py:function:: list_noncompliant_files(args, proj)
+
+   
+   Get a list of the files that are missing license headers.
+
+
+   :Parameters:
+
+       **args: argparse.Namespace**
+           Namespace of arguments with their values.
+
+       **proj: project.Project**
+           Project to run `REUSE <https://reuse.software/>`_ on.
+
+   :Returns:
+
+       :class:`python:list`
+           List of the files that are missing license headers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+   ..
+       !! processed by numpydoc !!
+
+.. py:function:: find_files_missing_header()
+
+   
+   Find files that are missing license headers and run `REUSE <https://reuse.software/>`_ on them.
+
+
+
+   :Returns:
+
+       :class:`python:int`
+           ``1`` if ``REUSE`` changed all noncompliant files.
+
+           ``2`` if the ``.reuse`` directory does not exist in the root path of the
+           GitHub repository.
+
+
+
+
+
+
+
+
+
+
+
+
+
+   ..
+       !! processed by numpydoc !!
+
+.. py:function:: check_reuse_dir()
+
+   
+   Check if the ``.reuse`` directory exists in the root path of the git repository.
+
+
+
+   :Returns:
+
+       :class:`python:str`
+           Root path of the git repository.
+
+       :class:`python:int`
+           ``1`` if  the ``.reuse`` directory does not exist in the root path
+           of the git repository.
+
+
+
+
+
+
+
+
+
+
+
+
+
+   ..
+       !! processed by numpydoc !!
+
+.. py:function:: run_reuse(parser, year, loc, missing_headers)
+
+   
+   Run `REUSE <https://reuse.software/>`_ on files that are missing license headers.
+
+
+   :Parameters:
+
+       **parser: argparse.ArgumentParser**
+           Parser containing the previously set arguments.
+
+       **year: int**
+           Current year for the license header.
+
+       **loc: str**
+           Location to search for files that are missing license headers.
+
+       **missing_headers: list**
+           List of files that are missing license headers.
+
+   :Returns:
+
+       :class:`python:int`
+           ``1`` if the pre-commit hook fails.
+
+           ``2`` if  the ``.reuse`` directory does not exist in the root path
+           of the GitHub repository.
+
+
+
+
+
+
+
+
+
+
+
+
+
+   ..
+       !! processed by numpydoc !!
+
+.. py:function:: main()
+
+   
+   Find files missing license headers and run `REUSE <https://reuse.software/>`_ on them.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+   ..
+       !! processed by numpydoc !!
+
diff --git a/version/0.1/_sources/autoapi/pre_commit_hooks/index.rst.txt b/version/0.1/_sources/autoapi/pre_commit_hooks/index.rst.txt
@@ -0,0 +1,38 @@
+:py:mod:`pre_commit_hooks`
+==========================
+
+.. py:module:: pre_commit_hooks
+
+.. autoapi-nested-parse::
+
+
+   Module for initializing package-level imports for Ansys pre-commit hooks.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+   ..
+       !! processed by numpydoc !!
+
+
+Submodules
+----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+   add_license_headers/index.rst
+
+
diff --git a/version/0.1/_sources/index.rst.txt b/version/0.1/_sources/index.rst.txt
@@ -0,0 +1,12 @@
+..
+   Just reuse the root readme to avoid duplicating the documentation.
+   Provide any documentation specific to your online documentation
+   here.
+
+.. include:: ../../README.rst
+
+.. toctree::
+   :hidden:
+   :maxdepth: 3
+
+   autoapi/index
diff --git a/version/0.1/_static/404.rst b/version/0.1/_static/404.rst
@@ -0,0 +1,6 @@
+Oops!
+=====
+
+This is unexpected. The page you are requesting does not exist.
+
+If this page should exist, please contact `{{ theme_contact_mail }} <{{ theme_contact_mail }}>`_.
diff --git a/version/0.1/_static/README.md b/version/0.1/_static/README.md
@@ -0,0 +1 @@
+Static files can be found here (like images and other assets).
diff --git a/version/0.1/_static/ansys-favicon.png b/version/0.1/_static/ansys-favicon.png
diff --git a/version/0.1/_static/ansys_logo_black.jpg b/version/0.1/_static/ansys_logo_black.jpg
diff --git a/version/0.1/_static/ansys_logo_black_cropped.jpg b/version/0.1/_static/ansys_logo_black_cropped.jpg
diff --git a/version/0.1/_static/ansys_logo_white.pdf b/version/0.1/_static/ansys_logo_white.pdf
diff --git a/version/0.1/_static/ansys_logo_white_cropped.pdf b/version/0.1/_static/ansys_logo_white_cropped.pdf