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

Fix the documentation #14

Merged
merged 53 commits into from Jan 19, 2023
Merged

Fix the documentation #14

merged 53 commits into from Jan 19, 2023

Conversation

clatapie
Copy link
Collaborator

Closes #8.

@clatapie clatapie self-assigned this Jan 10, 2023
@clatapie clatapie linked an issue Jan 10, 2023 that may be closed by this pull request
Doc fixes #8
Closed
3 tasks
@github-actions github-actions bot added dependencies Related with project dependencies documentation Improvements or additions to documentation maintenance Package and maintenance related bug Something isn't working labels Jan 10, 2023
@clatapie
Copy link
Collaborator Author

clatapie commented Jan 11, 2023 •
edited

Documentation organization:

  1. Getting Started
    1.1. How to install
    1.2. Verify your installation
  2. API Reference
  3. Examples
  4. Contributing
    4.1. Cloning repository
    4.2. Posting issues
    4.3. Building documentation
    4.4. Code Style

@clatapie clatapie marked this pull request as draft January 11, 2023 14:55
@clatapie clatapie marked this pull request as ready for review January 11, 2023 15:47
RobPasMue
RobPasMue reviewed Jan 12, 2023
View reviewed changes
README.rst Outdated Show resolved Hide resolved
RobPasMue
RobPasMue approved these changes Jan 12, 2023
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.

Overall, LGTM. Correct my comments. Also, ping Kathy for technical docs review before releasing

doc/source/conf.py Outdated Show resolved Hide resolved
doc/source/conf.py Outdated Show resolved Hide resolved
doc/source/conf.py Show resolved Hide resolved
doc/source/contributing/index.rst Outdated Show resolved Hide resolved
doc/source/getting_started/index.rst Outdated Show resolved Hide resolved
doc/source/links.rst Outdated Show resolved Hide resolved
examples/ansys-math_vs_scipy.py Outdated Show resolved Hide resolved
examples/basic_operations.py Outdated Show resolved Hide resolved
examples/eigen_solve.py Show resolved Hide resolved
examples/solve_dense_matrix.py Outdated Show resolved Hide resolved
PipKat
PipKat reviewed Jan 17, 2023
View reviewed changes
src/ansys/math/core/math.py Outdated Show resolved Hide resolved
PipKat
PipKat reviewed Jan 17, 2023
View reviewed changes
src/ansys/math/core/math.py Outdated Show resolved Hide resolved
PipKat
PipKat reviewed Jan 17, 2023
View reviewed changes
src/ansys/math/core/math.py Outdated Show resolved Hide resolved
PipKat
PipKat reviewed Jan 17, 2023
View reviewed changes
src/ansys/math/core/math.py Outdated Show resolved Hide resolved
PipKat
PipKat reviewed Jan 17, 2023
View reviewed changes
src/ansys/math/core/math.py Outdated Show resolved Hide resolved
PipKat
PipKat reviewed Jan 17, 2023
View reviewed changes
src/ansys/math/core/math.py Outdated Show resolved Hide resolved
PipKat
PipKat reviewed Jan 17, 2023
View reviewed changes
src/ansys/math/core/math.py Outdated Show resolved Hide resolved
PipKat
PipKat reviewed Jan 17, 2023
View reviewed changes
src/ansys/math/core/math.py Outdated Show resolved Hide resolved
PipKat
PipKat reviewed Jan 17, 2023
View reviewed changes
src/ansys/math/core/math.py Outdated Show resolved Hide resolved
PipKat
PipKat reviewed Jan 17, 2023
View reviewed changes
src/ansys/math/core/math.py Outdated Show resolved Hide resolved
PipKat
PipKat reviewed Jan 17, 2023
View reviewed changes
src/ansys/math/core/math.py Outdated Show resolved Hide resolved
PipKat
PipKat reviewed Jan 17, 2023
View reviewed changes
tests/test_math.py Outdated Show resolved Hide resolved
PipKat
PipKat reviewed Jan 17, 2023
View reviewed changes
tests/test_math.py Outdated Show resolved Hide resolved
PipKat
PipKat reviewed Jan 17, 2023
View reviewed changes
tests/test_math.py Outdated Show resolved Hide resolved
PipKat
PipKat reviewed Jan 17, 2023
View reviewed changes
tests/test_math.py Outdated Show resolved Hide resolved
PipKat
PipKat approved these changes Jan 17, 2023
View reviewed changes
Copy link
Member

@PipKat PipKat left a comment

Choose a reason for hiding this comment

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

If it's OK with @RobPasMue, I'm OK with you merging this PR. I would like to do a new PR just do go through the files again with new generated doc to look at as I go along. Thanks!

clatapie and others added 4 commits January 18, 2023 09:51
@clatapie @PipKat
Apply suggestions from code review - Examples files
81adfba 
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
@clatapie @PipKat
Apply suggestions from code review
9978412 
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
@clatapie
Fixing the _autosummary warnings
70b4858
@clatapie
Merge branch 'fix/documentation' of https://github.com/pyansys/ansys-…
114a5c6 
…math into fix/documentation
@clatapie
Copy link
Collaborator Author

Hi @PipKat! Thank you for your review!
I can't load the comments from the math.py file probably because there are too many. Thus, I will resolve them manually.

RobPasMue
RobPasMue approved these changes Jan 19, 2023
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.

This is good to go! Thanks @clatapie for implementing it, and thanks @PipKat for the thorough review!!

@clatapie clatapie enabled auto-merge (squash) January 19, 2023 08:55
@clatapie clatapie merged commit dadfe46 into main Jan 19, 2023
@clatapie clatapie deleted the fix/documentation branch January 19, 2023 08:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@germa89 germa89 germa89 approved these changes

@RobPasMue RobPasMue RobPasMue approved these changes

@PipKat PipKat PipKat approved these changes

@FredAns FredAns Awaiting requested review from FredAns

Assignees

@clatapie clatapie

Labels
bug Something isn't working dependencies Related with project dependencies documentation Improvements or additions to documentation maintenance Package and maintenance related
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Doc fixes
4 participants
@clatapie @PipKat @RobPasMue @germa89