From e498f9de474fc988bc77cedf354654a710fcbc8f Mon Sep 17 00:00:00 2001 From: RobPasMue Date: Fri, 3 Jun 2022 15:58:46 +0200 Subject: [PATCH 1/2] References to PyAnsys - modified --- .github/workflows/label.yml | 12 ++++++------ README.rst | 10 +++++----- doc/source/coding_style.rst | 6 +++--- doc/source/conf.py | 4 ++-- doc/source/style.rst | 2 +- doc/source/usage.rst | 2 +- pyproject.toml | 6 +++--- tox.ini | 2 +- 8 files changed, 22 insertions(+), 22 deletions(-) diff --git a/.github/workflows/label.yml b/.github/workflows/label.yml index 1dcf5b01..79aed008 100644 --- a/.github/workflows/label.yml +++ b/.github/workflows/label.yml @@ -74,9 +74,9 @@ jobs: issue-number: ${{ github.event.pull_request.number }} body: | Please add one of the following labels to add this contribution to the Release Notes :point_down: - - [bug](https://github.com/pyansys/pyansys-sphinx-theme/pulls?q=label%3Abug+) - - [documentation](https://github.com/pyansys/pyansys-sphinx-theme/pulls?q=label%3Adocumentation+) - - [enhancement](https://github.com/pyansys/pyansys-sphinx-theme/pulls?q=label%3Aenhancement+) - - [good first issue](https://github.com/pyansys/pyansys-sphinx-theme/pulls?q=label%3Agood+first+issue) - - [maintenance](https://github.com/pyansys/pyansys-sphinx-theme/pulls?q=label%3Amaintenance+) - - [release](https://github.com/pyansys/pyansys-sphinx-theme/pulls?q=label%3Arelease+) + - [bug](https://github.com/ansys/ansys-sphinx-theme/pulls?q=label%3Abug+) + - [documentation](https://github.com/ansys/ansys-sphinx-theme/pulls?q=label%3Adocumentation+) + - [enhancement](https://github.com/ansys/ansys-sphinx-theme/pulls?q=label%3Aenhancement+) + - [good first issue](https://github.com/ansys/ansys-sphinx-theme/pulls?q=label%3Agood+first+issue) + - [maintenance](https://github.com/ansys/ansys-sphinx-theme/pulls?q=label%3Amaintenance+) + - [release](https://github.com/ansys/ansys-sphinx-theme/pulls?q=label%3Arelease+) diff --git a/README.rst b/README.rst index 89fbf168..9ea6eeab 100644 --- a/README.rst +++ b/README.rst @@ -14,9 +14,9 @@ Ansys Sphinx Theme :target: https://pypi.org/project/ansys-sphinx-theme :alt: PyPI -.. |GH-CI| image:: https://github.com/pyansys/ansys-sphinx-theme/actions/workflows/ci_cd.yml/badge.svg - :target: https://github.com/pyansys/ansys-sphinx-theme/actions/workflows/ci_cd.yml - :alt: CH-CI +.. |GH-CI| image:: https://github.com/ansys/ansys-sphinx-theme/actions/workflows/ci_cd.yml/badge.svg + :target: https://github.com/ansys/ansys-sphinx-theme/actions/workflows/ci_cd.yml + :alt: GH-CI .. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg :target: https://opensource.org/licenses/MIT @@ -75,7 +75,7 @@ Development and Contributing ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Feel free to add features or post issues. To develop this theme:: - git clone https://github.com/pyansys/ansys-sphinx-theme.git + git clone https://github.com/ansys/ansys-sphinx-theme.git pip install -U pip tox tox -e style,doc @@ -88,4 +88,4 @@ optionally use this by following the `installation License ~~~~~~~ This theme is licensed under the `MIT License -`_. +`_. diff --git a/doc/source/coding_style.rst b/doc/source/coding_style.rst index 6858c916..9be668f8 100644 --- a/doc/source/coding_style.rst +++ b/doc/source/coding_style.rst @@ -5,10 +5,10 @@ Coding Style and Best Practices Until we have a site up for our best practices and coding style, the sphinx documentation site will host the coding style as well. -This page describes coding best practices applicable to the `pyansys +This page describes coding best practices applicable to the `PyAnsys `_ project. The purpose of this page is not to repeat coding style documentation, but rather to state -the approach used by the pyansys project when there are any +the approach used by the PyAnsys project when there are any delineations, clarifications, or additional procedures above and beyond `PEP8 `__. @@ -19,7 +19,7 @@ there's even a `Deprecation library guidance regarding deprecating features in an API within Python. This document seeks to clarify this issue and others. -Aside from pyansys specific directives, the best coding practice is to simply +Aside from PyAnsys specific directives, the best coding practice is to simply follow established guidelines from `PEP8 `__. diff --git a/doc/source/conf.py b/doc/source/conf.py index 78644452..3c6a3994 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -27,9 +27,9 @@ # specify the location of your github repo html_theme_options = { - "github_url": "https://github.com/pyansys/pyansys-sphinx-theme", + "github_url": "https://github.com/ansys/ansys-sphinx-theme", "additional_breadcrumbs": [ - ("PyAnsys", "https://docs.pyansys.com/"), + ("Ansys Internal Developer Portal", "https://dev.docs.ansys.com"), ], } diff --git a/doc/source/style.rst b/doc/source/style.rst index a0a14505..b14c336e 100644 --- a/doc/source/style.rst +++ b/doc/source/style.rst @@ -2,7 +2,7 @@ Documentation Style ******************* -PyAnsys packages should pick either the Google or Numpy documentation +Ansys packages should pick either the Google or Numpy documentation style when writing their docstrings. Adhering to this style permits the usage of the `sphinx.ext.napoleon `_ diff --git a/doc/source/usage.rst b/doc/source/usage.rst index 79121248..e94136fc 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -74,7 +74,7 @@ For example, this theme uses the following ``html_theme_options``: .. code:: python html_theme_options = { - "github_url": "https://github.com/pyansys/pyansys-sphinx-theme", + "github_url": "https://github.com/ansys/ansys-sphinx-theme", "show_prev_next": False, "show_breadcrumbs": True, "additional_breadcrumbs": diff --git a/pyproject.toml b/pyproject.toml index faee34f5..421c5e23 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -46,9 +46,9 @@ include = [ ] [project.urls] -Home = "https://docs.pyansys.com/" -Source = "https://github.com/pyansys/pyansys-sphinx-theme" -Tracker = "https://github.com/pyansys/pyansys-sphinx-theme/issues" +Home = "https://dev.docs.ansys.com/" +Source = "https://github.com/ansys/ansys-sphinx-theme" +Tracker = "https://github.com/ansys/ansys-sphinx-theme/issues" [tool.black] line-length = 100 diff --git a/tox.ini b/tox.ini index 662e5ad4..2353b462 100644 --- a/tox.ini +++ b/tox.ini @@ -25,7 +25,7 @@ basepython = {style,reformat,doc,build}: python3 setenv = PYTHONUNBUFFERED = yes - cov: PYTEST_EXTRA_ARGS = --cov=pyansys-sphinx-theme --cov-report=term --cov-report=xml --cov-report=html + cov: PYTEST_EXTRA_ARGS = --cov=ansys-sphinx-theme --cov-report=term --cov-report=xml --cov-report=html commands = pytest {env:PYTEST_MARKERS:} {env:PYTEST_EXTRA_ARGS:} {posargs:-vv} From 05737c81bdc24fba7c02af1d058c4e0efa939377 Mon Sep 17 00:00:00 2001 From: Roberto Pastor Muela Date: Fri, 3 Jun 2022 16:10:04 +0200 Subject: [PATCH 2/2] Update review suggestion from @jorgepiloto MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Jorge Martínez <28702884+jorgepiloto@users.noreply.github.com> --- doc/source/style.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/style.rst b/doc/source/style.rst index b14c336e..a0a14505 100644 --- a/doc/source/style.rst +++ b/doc/source/style.rst @@ -2,7 +2,7 @@ Documentation Style ******************* -Ansys packages should pick either the Google or Numpy documentation +PyAnsys packages should pick either the Google or Numpy documentation style when writing their docstrings. Adhering to this style permits the usage of the `sphinx.ext.napoleon `_