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 tutorials guidelines in the main tutorials branch #1950

Open
wants to merge 35 commits into
base: doc/new-tutorials-section
Choose a base branch
from

Conversation

luisaFelixSalles
Copy link
Collaborator

@luisaFelixSalles luisaFelixSalles commented Dec 3, 2024

Change the contributing section:

  • Updates on the main page
  • Add section specific for the documentation
  • Add guidelines to write tutorials

The contributing section is organized as :

.
├── Contributing
│   ├── Documentation
│   │    ├── Tutorials guidelines
│   ├── Develop code

Preview on how it renders

Contributing section main page

_D__ANSYSdev_pydpf-core_doc_build_html_getting_started_contributing html (1)

Documentation sub section

_D__ANSYSdev_pydpf-core_doc_build_html_getting_started_write_doc_index html (1)

Tutorials guidelines

_D__ANSYSdev_pydpf-core_doc_build_html_getting_started_write_doc_guide_lines_tutorials html

Develop code sub section

_D__ANSYSdev_pydpf-core_doc_build_html_getting_started_write_code_index html (1)

@luisaFelixSalles luisaFelixSalles added the tutorials Related to PyDPF-Core tutorials label Dec 3, 2024
@luisaFelixSalles luisaFelixSalles self-assigned this Dec 3, 2024
Copy link

codecov bot commented Dec 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.44%. Comparing base (627c2de) to head (3ae2f67).

Additional details and impacted files
@@                      Coverage Diff                      @@
##           doc/new-tutorials-section    #1950      +/-   ##
=============================================================
- Coverage                      88.50%   88.44%   -0.07%     
=============================================================
  Files                             89       89              
  Lines                          10251    10251              
=============================================================
- Hits                            9073     9066       -7     
- Misses                          1178     1185       +7     

@luisaFelixSalles luisaFelixSalles force-pushed the doc/new-tutorials-section branch from 576cd9f to 627c2de Compare December 19, 2024 16:42
@luisaFelixSalles luisaFelixSalles force-pushed the tutorials/guide-lines/firsts-guide-lines branch from b3654d3 to 27c4058 Compare January 3, 2025 14:53
@PProfizi
Copy link
Contributor

PProfizi commented Jan 3, 2025

Remark for later: redirect to the PyAnsys guidelines in the Develop code section.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tutorials Related to PyDPF-Core tutorials
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants