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.

Sign up for GitHub

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

Jump to bottom

Example for building documentation #1610

Merged
merged 11 commits into from
Nov 11, 2022
Merged

Example for building documentation #1610

merged 11 commits into from
Nov 11, 2022

Conversation

clatapie
Copy link
Contributor

@clatapie clatapie commented Nov 3, 2022

Solves #1585

@clatapie clatapie self-assigned this Nov 3, 2022
@clatapie clatapie linked an issue Nov 3, 2022 that may be closed by this pull request
Section about example building for doc in contribution #1585
Closed
@github-actions github-actions bot added the Documentation Documentation related (improving, adding, etc) label Nov 3, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Nov 3, 2022

Please add one of the following labels to add this contribution to the Release Notes 👇

@codecov
Copy link

codecov bot commented Nov 3, 2022 •
edited

Codecov Report

Merging #1610 (5972f74) into main (f6c5882) will decrease coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1610      +/-   ##
==========================================
- Coverage   82.82%   82.81%   -0.02%     
==========================================
  Files          44       44              
  Lines        7151     7151              
==========================================
- Hits         5923     5922       -1     
- Misses       1228     1229       +1

@germa89 germa89 self-requested a review November 4, 2022 08:46
@germa89
Copy link
Collaborator

germa89 commented Nov 4, 2022

Useful links:

:)

RobPasMue
RobPasMue reviewed Nov 7, 2022
View reviewed changes
doc/source/contribution_and_api/building_example Outdated Show resolved Hide resolved
doc/source/contribution_and_api/building_example Outdated Show resolved Hide resolved
doc/source/contribution_and_api/building_example Outdated Show resolved Hide resolved
doc/source/contribution_and_api/building_example Outdated Show resolved Hide resolved
doc/source/contribution_and_api/building_example Outdated Show resolved Hide resolved
@RobPasMue
Copy link
Member

By the way @clatapie - there seems to be a pymapdl directory added to this PR which should be deleted.

clatapie and others added 2 commits November 7, 2022 12:24
@clatapie @RobPasMue
Update doc/source/contribution_and_api/building_example
4476467 
Co-authored-by: Roberto Pastor Muela <roberto.pastormuela@ansys.com>
@clatapie @RobPasMue
Apply suggestions from code review
c02ab7c 
Co-authored-by: Roberto Pastor Muela <roberto.pastormuela@ansys.com>
@clatapie
Copy link
Contributor Author

clatapie commented Nov 7, 2022

By the way @clatapie - there seems to be a pymapdl directory added to this PR which should be deleted.

@clatapie clatapie closed this Nov 7, 2022
@clatapie clatapie reopened this Nov 7, 2022
@clatapie clatapie marked this pull request as ready for review November 7, 2022 13:38
RobPasMue
RobPasMue approved these changes Nov 7, 2022
View reviewed changes
Copy link
Member

@RobPasMue RobPasMue left a comment

Choose a reason for hiding this comment

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

LGTM! Though I will leave @germa89 to give more feedback on missing content he wants. Thanks @clatapie!

germa89
germa89 requested changes Nov 8, 2022
View reviewed changes
Copy link
Collaborator

@germa89 germa89 left a comment

Choose a reason for hiding this comment

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

Good job Camile!
I have minor suggestions:

  • Include some text where you recommend one example over the other. After reading this text, people should know that dynamic example should be very short, for everything else, static.

  • You include this text in the toctree index.rst which makes sense. However that leave it buried between the API doc. It is ok for now, but I might need to rethink this section. I had some complains about mixing API and contribution. But there are too many things already on our upper bar in the docs:

image

Any suggestion is welcome!

doc/source/contribution_and_api/building_example.rst Outdated Show resolved Hide resolved
@clatapie clatapie requested a review from germa89 November 9, 2022 09:31
germa89
germa89 approved these changes Nov 9, 2022
View reviewed changes
Copy link
Collaborator

@germa89 germa89 left a comment

Choose a reason for hiding this comment

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

Looks good to me! Thanks!

@germa89
Copy link
Collaborator

germa89 commented Nov 9, 2022

By the way, the text looks good, but everybody knows that English it is not my thing so quickly pinging @PipKat for a quick look :)

@germa89 germa89 requested a review from PipKat November 9, 2022 23:55
RobPasMue
RobPasMue approved these changes Nov 10, 2022
View reviewed changes
Copy link
Member

@RobPasMue RobPasMue left a comment

Choose a reason for hiding this comment

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

LGTM!

doc/source/contribution_and_api/building_example.rst Outdated Show resolved Hide resolved
@RobPasMue
Copy link
Member

PyMAPDL workflow is so much fun... Don't know why the tests are failing honestly, and the logs don't give much info...

@RobPasMue RobPasMue enabled auto-merge (squash) November 11, 2022 10:17
@RobPasMue RobPasMue merged commit 8850205 into main Nov 11, 2022
@RobPasMue RobPasMue deleted the doc/example_building branch November 11, 2022 10:30
@germa89
Copy link
Collaborator

germa89 commented Nov 17, 2022

PyMAPDL workflow is so much fun... Don't know why the tests are failing honestly, and the logs don't give much info...

Most of the times, just re-run it until it does not fail 😆

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RobPasMue RobPasMue RobPasMue approved these changes

@germa89 germa89 germa89 approved these changes

@PipKat PipKat Awaiting requested review from PipKat

Assignees

@clatapie clatapie

Labels
Documentation Documentation related (improving, adding, etc)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Section about example building for doc in contribution
3 participants
@clatapie @germa89 @RobPasMue