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

Add examples of extension libraries. #191

Merged
merged 41 commits into from
Feb 14, 2023
Merged

Conversation

Revathyvenugopal162
Copy link
Contributor

WIP

@github-actions github-actions bot added documentation maintenance Generic maintenance related enhancement General improvements to existing features labels Feb 2, 2023
@github-actions github-actions bot added the dependencies Related with project dependencies label Feb 2, 2023
@jorgepiloto
Copy link
Member

I do not think we are allowed to use those images or distribute those, @Revathyvenugopal162.

Also, you are executing the download of the examples during the CI/CD. That's smart but limits ourselves to only generate examples during the pipeline execution.

In my opinion, we should use a similar logic to the one in [pyansys/actions], where by using [sphinx-jinja], we can inject any sort of content into an RST file.

@Revathyvenugopal162
Copy link
Contributor Author

I do not think we are allowed to use those images or distribute those, @Revathyvenugopal162.

Also, you are executing the download of the examples during the CI/CD. That's smart but limits ourselves to only generate examples during the pipeline execution.

In my opinion, we should use a similar logic to the one in [pyansys/actions], where by using [sphinx-jinja], we can inject any sort of content into an RST file.

I was thinking of adding this code in conf file, also added this image to make sure it is working. I think We can do some modifications in the image.i will look in to using [sphinx-jinja]. But i am open to changes.
Thanks @jorgepiloto .

@Revathyvenugopal162 Revathyvenugopal162 marked this pull request as ready for review February 8, 2023 14:34
Co-authored-by: Jorge Martínez <28702884+jorgepiloto@users.noreply.github.com>
Co-authored-by: Jorge Martínez <28702884+jorgepiloto@users.noreply.github.com>
Copy link
Member

@jorgepiloto jorgepiloto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few minior coments. What about the particle_background.jpg file that is commited. Where is that image being used?

pyproject.toml Outdated Show resolved Hide resolved
doc/source/conf.py Outdated Show resolved Hide resolved
@Revathyvenugopal162
Copy link
Contributor Author

Few minior coments. What about the particle_background.jpg file that is commited. Where is that image being used?

That is the background image for sphinx card. in examples

Copy link
Member

@jorgepiloto jorgepiloto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome implementation, @Revathyvenugopal162. This is going to be really useful for our users. Approving. Feel free to merge 🚀

@Revathyvenugopal162
Copy link
Contributor Author

Thank you @jorgepiloto and @RobPasMue for the thorough review. merging!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Related with project dependencies enhancement General improvements to existing features maintenance Generic maintenance related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants