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

new DataSources tutorial #1774

Closed

Conversation

luisaFelixSalles
Copy link
Collaborator

This PR adds a new DataSources tutorial.

Sneak peek on how it renders:

image

image

image

@luisaFelixSalles luisaFelixSalles added the documentation Improvements or additions to documentation label Sep 25, 2024
@luisaFelixSalles luisaFelixSalles self-assigned this Sep 25, 2024
@luisaFelixSalles luisaFelixSalles mentioned this pull request Sep 24, 2024
31 tasks
@PProfizi PProfizi marked this pull request as ready for review September 25, 2024 14:40
'C:/Users/user/AppData/local/temp/ASimpleBar.rst'
my_data_sources_b.set_result_file_path(filepath=r'C:/Users/user/AppData/local/temp/ASimpleBar.rst', key='rst')

**c) Function** :func:`guess_result_key() <ansys.dpf.core.data_sources.DataSources.guess_result_key>`
Copy link
Contributor

Choose a reason for hiding this comment

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

Hey @jorgepiloto we are seeing annoying errors from Vale which does not exclude links to refs for functions. Do you know how to easily to solve this? Thanks!

Copy link
Member

Choose a reason for hiding this comment

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

Let me double check the configuration

Copy link
Member

Choose a reason for hiding this comment

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

I am not sure how I was able to accidentally push the commit to master. This branch is protected and forcing a pull-request. Moreover, nobody can overcome previous restriction. The commit is this one: ca11a17

Copy link
Member

Choose a reason for hiding this comment

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

Just cherry-picked in 9127909

luisaFelixSalles and others added 2 commits September 26, 2024 09:31
Co-authored-by: Paul Profizi <100710998+PProfizi@users.noreply.github.com>
@clatapie
Copy link
Contributor

The Vale errors should be fixed now. Feel free to reach out if you have any questions!

TokenIgnores = (:(func|class|meth|attr|py|py:class|py:meth):`(?:.|\n)*?`)|(<.*>)|
Copy link
Member

Choose a reason for hiding this comment

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

Thanks a lot, @clatapie 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants