diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml index f0b0282b..b2c25cc5 100644 --- a/.github/workflows/ci_cd.yml +++ b/.github/workflows/ci_cd.yml @@ -16,9 +16,9 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Setup Python - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: 3.8 @@ -73,7 +73,7 @@ jobs: uses: codecov/codecov-action@v3 - name: Upload wheel - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: ansys-product-library-wheel path: dist/ @@ -84,9 +84,9 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Setup Python - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: 3.8 @@ -104,15 +104,15 @@ jobs: # sudo apt-get install -y texlive-latex-extra latexmk # make -C doc latexpdf - # - name: Upload HTML Documentation - # uses: actions/upload-artifact@v2 - # with: - # name: Documentation-html - # path: doc/build/html - # retention-days: 7 + - name: Upload HTML Documentation + uses: actions/upload-artifact@v3 + with: + name: Documentation-html + path: doc/_build/html + retention-days: 7 # - name: Upload PDF Documentation - # uses: actions/upload-artifact@v2 + # uses: actions/upload-artifact@v3 # with: # name: Documentation-pdf # path: doc/build/latex/*.pdf @@ -124,21 +124,21 @@ jobs: runs-on: ubuntu-latest steps: - name: Set up Python - uses: actions/setup-python@v1 + uses: actions/setup-python@v4 with: python-version: 3.9 - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - - uses: actions/download-artifact@v2 + - uses: actions/download-artifact@v3 with: name: ansys-product-library-wheel - - uses: actions/download-artifact@v2 + - uses: actions/download-artifact@v3 with: name: Documentation-pdf - - uses: actions/download-artifact@v2 + - uses: actions/download-artifact@v3 with: name: Documentation-html path: ~/html @@ -148,7 +148,7 @@ jobs: run: ls -R - name: Deploy - uses: JamesIves/github-pages-deploy-action@4.1.5 + uses: JamesIves/github-pages-deploy-action@4.4 with: BRANCH: gh-pages FOLDER: ~/html diff --git a/.gitignore b/.gitignore index a203ca30..ee590b7c 100644 --- a/.gitignore +++ b/.gitignore @@ -45,3 +45,4 @@ test-output.xml .venv .DS_Store +doc/_build/*/* diff --git a/README.rst b/README.rst index f6fccceb..70ef269a 100644 --- a/README.rst +++ b/README.rst @@ -102,6 +102,7 @@ need to follow these steps: python -m pip install --editable ansys-tools-path +.. howtouse How to testing -------------- @@ -157,3 +158,4 @@ the building requirements and then executing the build module: .. _pytest: https://docs.pytest.org/en/stable/ .. _Sphinx: https://www.sphinx-doc.org/en/master/ .. _tox: https://tox.wiki/ +.. _api: diff --git a/doc/source/API.rst b/doc/source/API.rst new file mode 100644 index 00000000..2c8edc47 --- /dev/null +++ b/doc/source/API.rst @@ -0,0 +1,14 @@ +.. _ref_api: + +API +======== + +.. currentmodule:: ansys.tools.path + +.. autosummary:: + :toctree: _autosummary + + find_ansys + get_available_ansys_installations + change_default_ansys_path + save_ansys_path \ No newline at end of file diff --git a/doc/source/_templates/sidebar-nav-bs.html b/doc/source/_templates/sidebar-nav-bs.html index 0554e82e..0747bd05 100644 --- a/doc/source/_templates/sidebar-nav-bs.html +++ b/doc/source/_templates/sidebar-nav-bs.html @@ -1,9 +1,9 @@