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

WIP: use jupytext into examples and documentation #3940

Closed
wants to merge 61 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
61 commits
Select commit Hold shift + click to select a range
34894fb
WIP: remove files for test purpose
SMoraisAnsys Dec 4, 2023
eac4c98
WIP: update full doc workflow
SMoraisAnsys Dec 4, 2023
25c1a1f
WIP: enalbe textbook in conf.py
SMoraisAnsys Dec 4, 2023
e834e73
WIP: remove part of doc
SMoraisAnsys Dec 4, 2023
4184311
WIP: update example with code tags
SMoraisAnsys Dec 4, 2023
a3f4e4b
WIP: remove conf
SMoraisAnsys Dec 4, 2023
126ff77
WIP: delete extra rst files
SMoraisAnsys Dec 4, 2023
adb80bf
WIP: update doc doc
SMoraisAnsys Dec 4, 2023
84fa4e1
WIP: add removed readme.txt
SMoraisAnsys Dec 4, 2023
651ddbc
WIP: rework example format
SMoraisAnsys Dec 5, 2023
077c5d3
WIP: try to remove output from cells
SMoraisAnsys Dec 5, 2023
c73c8bf
WIP: use markdown style cells
SMoraisAnsys Dec 5, 2023
452633e
WIP: add css file to remove code cells output
SMoraisAnsys Dec 5, 2023
28f41e1
WIP: fix lack of docstring
SMoraisAnsys Dec 5, 2023
5bf5c32
WIP: update doc dependencies
SMoraisAnsys Dec 7, 2023
2ddc64c
MISC: update windows make.bat
SMoraisAnsys Dec 7, 2023
956b40c
DOC: huge rework of doc conf
SMoraisAnsys Dec 7, 2023
f20c589
WIP: rework doc to only build one example
SMoraisAnsys Dec 7, 2023
c64e0c5
MISC: clean up
SMoraisAnsys Dec 7, 2023
4de9e31
MISC: remove tests files after rebase
SMoraisAnsys Dec 7, 2023
b5a034d
WIP: remove files for test purpose
SMoraisAnsys Dec 4, 2023
45d74d0
WIP: update full doc workflow
SMoraisAnsys Dec 4, 2023
bb577e5
WIP: enalbe textbook in conf.py
SMoraisAnsys Dec 4, 2023
5585172
WIP: remove part of doc
SMoraisAnsys Dec 4, 2023
25f8518
WIP: update example with code tags
SMoraisAnsys Dec 4, 2023
0fc73ad
WIP: remove conf
SMoraisAnsys Dec 4, 2023
9def4c4
WIP: delete extra rst files
SMoraisAnsys Dec 4, 2023
7933711
WIP: update doc doc
SMoraisAnsys Dec 4, 2023
ce342fb
WIP: add removed readme.txt
SMoraisAnsys Dec 4, 2023
ac71bc9
WIP: rework example format
SMoraisAnsys Dec 5, 2023
08b8461
WIP: try to remove output from cells
SMoraisAnsys Dec 5, 2023
0245645
WIP: use markdown style cells
SMoraisAnsys Dec 5, 2023
6c4d65b
WIP: add css file to remove code cells output
SMoraisAnsys Dec 5, 2023
5397eba
WIP: fix lack of docstring
SMoraisAnsys Dec 5, 2023
09e9180
WIP: update doc dependencies
SMoraisAnsys Dec 7, 2023
4ec8291
MISC: update windows make.bat
SMoraisAnsys Dec 7, 2023
d45f04c
DOC: huge rework of doc conf
SMoraisAnsys Dec 7, 2023
1a5d40d
WIP: rework doc to only build one example
SMoraisAnsys Dec 7, 2023
bfc0271
MISC: clean up
SMoraisAnsys Dec 7, 2023
a979fe9
MISC: remove tests files after rebase
SMoraisAnsys Dec 7, 2023
c005d6d
CI: use make.bat to build documentation
SMoraisAnsys Dec 7, 2023
e068fa0
MISC: add example ignored by git
SMoraisAnsys Dec 7, 2023
999a2cd
CI: add pandoc install
SMoraisAnsys Dec 7, 2023
5d47a53
Merge remote-tracking branch 'origin/doc/use_jupytext' into doc/use_j…
Devin-Crawford Dec 8, 2023
bae06ca
CI: use absolute path for chocolatey
SMoraisAnsys Dec 8, 2023
c1102ec
CI: force pandoc install
SMoraisAnsys Dec 8, 2023
8fde402
Merge remote-tracking branch 'origin/doc/use_jupytext' into doc/use_j…
Devin-Crawford Dec 10, 2023
5b3bc88
Set BUILD_EXAMPLES to true
Devin-Crawford Dec 10, 2023
2c9ffbb
Add the pandoc path to PATH
Devin-Crawford Dec 10, 2023
918cf77
Add the pandoc path to PATH
Devin-Crawford Dec 10, 2023
17e1ae5
Add the pandoc path to PATH
Devin-Crawford Dec 10, 2023
7a16fc3
Add the pandoc path to PATH
Devin-Crawford Dec 10, 2023
9f3fc56
Add the pandoc path to PATH
Devin-Crawford Dec 10, 2023
6c65887
Add the chocolatey path to PATH
Devin-Crawford Dec 10, 2023
e78be75
Add the chocolatey path to PATH
Devin-Crawford Dec 10, 2023
f5e48a1
Explicitly set path to pandoc
Devin-Crawford Dec 10, 2023
86da682
Explicitly set path to pandoc
Devin-Crawford Dec 10, 2023
5f7c740
Update suffix for Sphinx notebooks
Devin-Crawford Dec 11, 2023
59edf52
Update suffix for Sphinx notebooks
Devin-Crawford Dec 11, 2023
7b5f1ce
Fix error
Devin-Crawford Dec 11, 2023
d4505bb
Add examples files in old format.
Devin-Crawford Jan 4, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
95 changes: 0 additions & 95 deletions .github/workflows/build_documentation.yml

This file was deleted.

91 changes: 0 additions & 91 deletions .github/workflows/cpython_linux.yml

This file was deleted.

41 changes: 21 additions & 20 deletions .github/workflows/full_documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,7 @@ env:
MEILISEARCH_HOST_URL: https://backend.search.pyansys.com
MEILISEARCH_PUBLIC_API_KEY: ${{ secrets.MEILISEARCH_PUBLIC_API_KEY }}
# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request events but only for the main branch
push:
tags:
- v*
workflow_dispatch:
inputs:
logLevel:
description: 'Log level'
required: true
default: 'warning'
tags:
description: 'Test scenario tags'
on: [pull_request, workflow_dispatch]

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
Expand All @@ -47,6 +35,17 @@ jobs:
with:
python-version: ${{ matrix.python-version }}

# TODO: install pandoc on self hosted runners to remove this step
- name: Install Chocolatey and Pandoc if necessary
run: |
# Check if Chocolatey is installed
if ((Get-Command choco -ErrorAction SilentlyContinue) -eq $null) {
# Install Chocolatey
Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))
}

C:\ProgramData\chocolatey\bin\choco install pandoc -y

- name: 'Create virtual env'
run: |
python -m venv testenv
Expand All @@ -71,7 +70,9 @@ jobs:
- name: Create HTML Documentations
run: |
testenv\Scripts\Activate.ps1
sphinx-build -j auto --color -b html -a doc/source doc/_build/html
cd doc
.\make.bat html
# sphinx-build -j auto --color -b html -a doc/source doc/_build/html

# - name: Create PDF Documentations
# run: |
Expand All @@ -85,12 +86,12 @@ jobs:
path: doc/_build/html
retention-days: 7

- name: Upload HTML documentation artifact
uses: actions/upload-artifact@v3
with:
name: documentation-html-edb
path: doc/_build/html/EDBAPI
retention-days: 7
# - name: Upload HTML documentation artifact
# uses: actions/upload-artifact@v3
# with:
# name: documentation-html-edb
# path: doc/_build/html/EDBAPI
# retention-days: 7

# - name: Upload PDF documentation artifact
# uses: actions/upload-artifact@v3
Expand Down
40 changes: 0 additions & 40 deletions .github/workflows/ironpython.yml

This file was deleted.

Loading