Skip to content

Commit

Permalink
MAINT: Fix CI/CD and doc build (#163)
Browse files Browse the repository at this point in the history
  • Loading branch information
rfahlberg authored Aug 16, 2023
1 parent 51ba732 commit 8276bf1
Show file tree
Hide file tree
Showing 8 changed files with 35 additions and 35 deletions.
24 changes: 12 additions & 12 deletions .github/workflows/ci_cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ jobs:
name: "Code style"
runs-on: ubuntu-latest
steps:
- uses: pyansys/actions/code-style@v4
- uses: ansys/actions/code-style@v4
with:
python-version: ${{ env.MAIN_PYTHON_VERSION }}

doc-style:
name: "Doc style check"
runs-on: ubuntu-latest
steps:
- uses: pyansys/actions/doc-style@v4
- uses: ansys/actions/doc-style@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}

Expand All @@ -45,13 +45,13 @@ jobs:
matrix:
os: [ubuntu-latest, windows-latest, macos-latest]
python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
should-release:
should-release:
- ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags') }}
exclude:
- should-release: false
os: macos-latest
steps:
- uses: pyansys/actions/build-wheelhouse@v4
- uses: ansys/actions/build-wheelhouse@v4
with:
library-name: ${{ env.PACKAGE_NAME }}
library-namespace: ${{ env.PACKAGE_NAMESPACE }}
Expand All @@ -68,7 +68,7 @@ jobs:
matrix:
os: [ubuntu-latest, windows-latest, macos-latest]
python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
should-release:
should-release:
- ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags') }}
exclude:
- should-release: false
Expand All @@ -77,7 +77,7 @@ jobs:

steps:
- name: "Run pytest with desired markers and extra arguments"
uses: pyansys/actions/tests-pytest@v4
uses: ansys/actions/tests-pytest@v4
with:
python-version: ${{ matrix.python-version }}
pytest-extra-args: ${{ env.PYTEST_EXTRA_ARGS }}
Expand Down Expand Up @@ -105,7 +105,7 @@ jobs:
runs-on: ubuntu-latest
needs: doc-style
steps:
- uses: pyansys/actions/doc-build@v4
- uses: ansys/actions/doc-build@v4
with:
python-version: ${{ env.MAIN_PYTHON_VERSION }}
dependencies: "pandoc"
Expand All @@ -115,7 +115,7 @@ jobs:
needs: [doc, tests]
runs-on: ubuntu-latest
steps:
- uses: pyansys/actions/build-library@v4
- uses: ansys/actions/build-library@v4
with:
library-name: ${{ env.PACKAGE_NAME }}
python-version: ${{ env.MAIN_PYTHON_VERSION }}
Expand All @@ -127,14 +127,14 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: "Release to the public PyPI repository"
uses: pyansys/actions/release-pypi-public@v4
uses: ansys/actions/release-pypi-public@v4
with:
library-name: ${{ env.PACKAGE_NAME }}
twine-username: "__token__"
twine-token: ${{ secrets.PYPI_TOKEN }}

- name: "Release to GitHub"
uses: pyansys/actions/release-github@v4
uses: ansys/actions/release-github@v4
with:
library-name: ${{ env.PACKAGE_NAME }}

Expand All @@ -144,7 +144,7 @@ jobs:
runs-on: ubuntu-latest
needs: build-library
steps:
- uses: pyansys/actions/doc-deploy-dev@v4
- uses: ansys/actions/doc-deploy-dev@v4
with:
cname: ${{ env.DOCUMENTATION_CNAME }}
token: ${{ secrets.GITHUB_TOKEN }}
Expand All @@ -155,7 +155,7 @@ jobs:
runs-on: ubuntu-latest
needs: release
steps:
- uses: pyansys/actions/doc-deploy-stable@v4
- uses: ansys/actions/doc-deploy-stable@v4
with:
cname: ${{ env.DOCUMENTATION_CNAME }}
token: ${{ secrets.GITHUB_TOKEN }}
18 changes: 9 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ PyOptiSLang
.. |PyPIact| image:: https://img.shields.io/pypi/dm/ansys-optislang-core.svg?label=PyPI%20downloads
:target: https://pypi.org/project/ansys-optislang-core/

.. |codecov| image:: https://codecov.io/gh/pyansys/pyoptislang/branch/main/graph/badge.svg
:target: https://codecov.io/gh/pyansys/pyoptislang
.. |codecov| image:: https://codecov.io/gh/ansys/pyoptislang/branch/main/graph/badge.svg
:target: https://codecov.io/gh/ansys/pyoptislang
:alt: Codecov

.. |GH-CI| image:: https://github.com/pyansys/pyoptislang/actions/workflows/ci_cd.yml/badge.svg
:target: https://github.com/pyansys/pyoptislang/actions/workflows/ci_cd.yml
.. |GH-CI| image:: https://github.com/ansys/pyoptislang/actions/workflows/ci_cd.yml/badge.svg
:target: https://github.com/ansys/pyoptislang/actions/workflows/ci_cd.yml
:alt: GH-CI

.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
Expand Down Expand Up @@ -53,7 +53,7 @@ Documentation and issues
------------------------
For comprehensive information on PyOptiSLang, see the latest release
`documentation <https://optislang.docs.pyansys.com>`_. On the
`PyOptiSLang Issues <https://github.com/pyansys/pyoptislang/issues>`_ page,
`PyOptiSLang Issues <https://github.com/ansys/pyoptislang/issues>`_ page,
you can create issues to submit questions, report bugs, and request new features.
This is the best place to post questions and code.

Expand All @@ -80,11 +80,11 @@ Install the latest release from `PyPi
Alternatively, install the latest `PyOptiSLang GitHub
<https://github.com/pyansys/pyoptislang/issues>`_ package with this command:
<https://github.com/ansys/pyoptislang/issues>`_ package with this command:

.. code::
pip install git+https://github.com/pyansys/pyoptislang.git
pip install git+https://github.com/ansys/pyoptislang.git
Developer installation
Expand All @@ -94,7 +94,7 @@ install PyOptiSLang with this code:

.. code::
git clone https://github.com/pyansys/pyoptislang.git
git clone https://github.com/ansys/pyoptislang.git
cd pyoptislang
pip install -e .
Expand All @@ -106,7 +106,7 @@ after restarting the Python kernel.
Offline installation
~~~~~~~~~~~~~~~~~~~~
Using a wheelhouse can be helpful if you work for a company that restricts access to
external networks. From the `Releases <https://github.com/pyansys/pyoptislang/releases>`_
external networks. From the `Releases <https://github.com/ansys/pyoptislang/releases>`_
page in the PyOptiSLang repository, you can find the wheelhouses for a particular release in its
assets and download the wheelhouse corresponding to your setup.

Expand Down
2 changes: 1 addition & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@
html_theme = "ansys_sphinx_theme"
html_logo = pyansys_logo_black
html_theme_options = {
"github_url": "https://github.com/pyansys/pyoptislang",
"github_url": "https://github.com/ansys/pyoptislang",
"show_prev_next": False,
"show_breadcrumbs": True,
"collapse_navigation": True,
Expand Down
6 changes: 3 additions & 3 deletions doc/source/contributing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Contribute
==========
Overall guidance on contributing to a PyAnsys library appears in the
`Contributing <https://dev.docs.pyansys.com/overview/contributing.html>`_ topic
`Contributing <https://dev.docs.pyansys.com/how-to/contributing.html>`_ topic
in the *PyAnsys Developer's Guide*. Ensure that you are thoroughly familiar
with this guide before attempting to contribute to PyOptiSLang.

Expand All @@ -17,15 +17,15 @@ release in development mode, run this code:

.. code::
git clone https://github.com/pyansys/pyoptislang
git clone https://github.com/ansys/pyoptislang
cd pyoptislang
pip install pip -U
pip install -e .
Post issues
-----------
Use the `PyOptiSLang Issues <https://github.com/pyansys/pyoptislang/issues>`_
Use the `PyOptiSLang Issues <https://github.com/ansys/pyoptislang/issues>`_
page to submit questions, report bugs, and request new features. When possible,
use these issue templates:

Expand Down
12 changes: 6 additions & 6 deletions doc/source/getting_started/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Getting started
===============
To run PyOptiSLang, you must have access to a licensed copy of optiSLang. The first
supported version of optiSLang is 2023 R1. For more information on optiSLang, see the
To run PyOptiSLang, you must have access to a licensed copy of optiSLang. The first
supported version of optiSLang is 2023 R1. For more information on optiSLang, see the
`Ansys optiSLang <https://www.ansys.com/products/connect/ansys-optislang>`_ page
on the Ansys website.

Expand Down Expand Up @@ -29,11 +29,11 @@ Install the latest release from `PyPi
Alternatively, install the latest `PyOptiSLang GitHub
<https://github.com/pyansys/pyoptislang/issues>`_ package with this command:
<https://github.com/ansys/pyoptislang/issues>`_ package with this command:

.. code::
pip install git+https://github.com/pyansys/pyoptislang.git
pip install git+https://github.com/ansys/pyoptislang.git
Developer installation
Expand All @@ -43,7 +43,7 @@ clone and install PyOptiSLang with this code:

.. code::
git clone https://github.com/pyansys/pyoptislang.git
git clone https://github.com/ansys/pyoptislang.git
cd pyoptislang
pip install -e .
Expand All @@ -55,7 +55,7 @@ after restarting the Python kernel.
Offline installation
~~~~~~~~~~~~~~~~~~~~
Using a wheelhouse can be helpful if you work for a company that restricts access to
external networks. From the `Releases <https://github.com/pyansys/pyoptislang/releases>`_
external networks. From the `Releases <https://github.com/ansys/pyoptislang/releases>`_
page in the PyOptiSLang repository, you can find the wheelhouses for a particular release in its
assets and download the wheelhouse corresponding to your setup.

Expand Down
2 changes: 1 addition & 1 deletion doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Documentation and issues
In addition to installation and usage information, the PyOptiSLang documentation provides
API member descriptions, examples, and contribution information.

On the `PyOptiSLang Issues <https://github.com/pyansys/pyoptislang/issues>`_ page, you can create
On the `PyOptiSLang Issues <https://github.com/ansys/pyoptislang/issues>`_ page, you can create
issues to submit questions, report bugs, and request new features. This is the best place to post
questions and code.

Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ name = "ansys.optislang.core"
[project.urls]
Homepage = "https://optislang.docs.pyansys.com"
Documentation = "https://optislang.docs.pyansys.com"
Source = "https://github.com/pyansys/pyoptislang"
Tracker = "https://github.com/pyansys/pyoptislang/issues"
Source = "https://github.com/ansys/pyoptislang"
Tracker = "https://github.com/ansys/pyoptislang/issues"

[tool.black]
line-length = 100
Expand Down
2 changes: 1 addition & 1 deletion src/ansys/optislang/core/examples/downloads.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import ansys.optislang.core.examples as examples

# TODO: implement automatic download from online repository
# EXAMPLE_REPO = "https://github.com/pyansys/pyoptislang/tree/main/examples/files"
# EXAMPLE_REPO = "https://github.com/ansys/pyoptislang/tree/main/examples/files"


def _download_files(scriptname: str) -> Tuple[Path, ...]:
Expand Down

0 comments on commit 8276bf1

Please sign in to comment.