Skip to content

New How-To chapter #100

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
Merged
merged 31 commits into from
Jun 9, 2022
Merged

New How-To chapter #100

merged 31 commits into from
Jun 9, 2022

Conversation

jorgepiloto
Copy link
Member

@jorgepiloto jorgepiloto commented May 24, 2022 •
edited by Revathyvenugopal162
Loading

Partially solves for #64 by adding a "How-To" section.

  • Setting up Your Development Environment
  • Python Version Support
  • Logging
  • Documenting
  • Testing
  • Using Continuous Integration
  • Releasing and Publishing

Fix #108 by adding the latex-documentation under the section 'documenting' .

@jorgepiloto jorgepiloto force-pushed the feat/how-to branch 6 times, most recently from 6a03586 to 7742c65 Compare May 24, 2022 17:12
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed May 24, 2022
View reviewed changes
PipKat
PipKat reviewed Jun 3, 2022
View reviewed changes
doc/source/how-to/documenting.rst Outdated
recommend the use of numpy-style docstrings so that there is consistency
within PyAnsys libraries. For more information, see :ref:`Documentation Style`.

RST Files
Copy link
Member

@PipKat PipKat Jun 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

We need to check if this is the first reference to RST files--it needs to defined as ReStructured Text (RST) files on first reference before RST can be used subsequently.

PipKat
PipKat reviewed Jun 3, 2022
View reviewed changes
PipKat
PipKat reviewed Jun 3, 2022
View reviewed changes
PipKat
PipKat reviewed Jun 3, 2022
View reviewed changes
PipKat
PipKat reviewed Jun 3, 2022
View reviewed changes
PipKat
PipKat reviewed Jun 3, 2022
View reviewed changes
PipKat
PipKat reviewed Jun 3, 2022
View reviewed changes
PipKat
PipKat reviewed Jun 3, 2022
View reviewed changes
PipKat
PipKat reviewed Jun 3, 2022
View reviewed changes
PipKat
PipKat approved these changes Jun 3, 2022
View reviewed changes
jorgepiloto
jorgepiloto commented Jun 6, 2022
View reviewed changes
jorgepiloto
jorgepiloto commented Jun 8, 2022
View reviewed changes
jorgepiloto
jorgepiloto commented Jun 8, 2022
View reviewed changes
jorgepiloto
jorgepiloto commented Jun 8, 2022
View reviewed changes
jorgepiloto
jorgepiloto commented Jun 8, 2022
View reviewed changes
jorgepiloto
jorgepiloto commented Jun 8, 2022
View reviewed changes
jorgepiloto
jorgepiloto commented Jun 9, 2022
View reviewed changes
jorgepiloto
jorgepiloto commented Jun 9, 2022
View reviewed changes
MaxJPRey
MaxJPRey reviewed Jun 9, 2022
View reviewed changes
jorgepiloto
jorgepiloto commented Jun 9, 2022
View reviewed changes
@jorgepiloto
Copy link
Member Author

Squashing the commits coming from suggestions. Merging this in a couple of minutes.

@jorgepiloto
Copy link
Member Author

Need to check CI too.

@jorgepiloto jorgepiloto removed the request for review from Revathyvenugopal162 June 9, 2022 13:25
@RobPasMue RobPasMue dismissed germa89’s stale review June 9, 2022 13:28

Already implemented

@jorgepiloto jorgepiloto merged commit 481f6aa into main Jun 9, 2022
@jorgepiloto jorgepiloto deleted the feat/how-to branch June 9, 2022 13:28
@jorgepiloto
Copy link
Member Author

Finally implemented! 🚀

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

@MaxJPRey MaxJPRey MaxJPRey left review comments

@PipKat PipKat PipKat approved these changes

@akaszynski akaszynski Awaiting requested review from akaszynski

@germa89 germa89 Awaiting requested review from germa89

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Latex Build documentation
6 participants
@jorgepiloto @RobPasMue @germa89 @PipKat @MaxJPRey @Revathyvenugopal162