Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Solving references to PyAnsys #67

Merged
merged 2 commits into from
Jun 3, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
12 changes: 6 additions & 6 deletions .github/workflows/label.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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+)
10 changes: 5 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand All @@ -88,4 +88,4 @@ optionally use this by following the `installation
License
~~~~~~~
This theme is licensed under the `MIT License
<https://raw.githubusercontent.com/pyansys/ansys-sphinx-theme/main/LICENSE>`_.
<https://raw.githubusercontent.com/ansys/ansys-sphinx-theme/main/LICENSE>`_.
6 changes: 3 additions & 3 deletions doc/source/coding_style.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://pypi.org/project/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 <https://www.python.org/dev/peps/pep-0008/>`__.

Expand All @@ -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 <https://www.python.org/dev/peps/pep-0008/>`__.


Expand Down
4 changes: 2 additions & 2 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"),
],
}

Expand Down
2 changes: 1 addition & 1 deletion doc/source/style.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
RobPasMue marked this conversation as resolved.
Show resolved Hide resolved
style when writing their docstrings. Adhering to this style permits
the usage of the `sphinx.ext.napoleon
<https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html>`_
Expand Down
2 changes: 1 addition & 1 deletion doc/source/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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":
Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -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}

Expand Down