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

Update documentation #129

Merged
merged 21 commits into from
May 31, 2024
Merged

Update documentation #129

merged 21 commits into from
May 31, 2024

Conversation

rodolakis
Copy link
Collaborator

@rodolakis rodolakis commented May 28, 2024 •
edited
Loading

@rodolakis rodolakis added the documentation Improvements or additions to documentation label May 28, 2024
@rodolakis rodolakis added this to the v1.0 milestone May 28, 2024
@rodolakis rodolakis self-assigned this May 28, 2024
@rodolakis
Copy link
Collaborator Author

image

@rodolakis rodolakis marked this pull request as ready for review May 28, 2024 20:33
@rodolakis rodolakis changed the title Update documentation Update installation instructions May 28, 2024
@rodolakis rodolakis marked this pull request as draft May 28, 2024 22:33
@rodolakis
Copy link
Collaborator Author

@prjemian converting back to draft, trying to improve the home page a bit. I will let you know when it is ready for review.

@rodolakis rodolakis changed the title Update installation instructions Update documentation May 28, 2024
@rodolakis
Copy link
Collaborator Author

I believe this is ready to commit. It is only documentation. I fixed all the docstrings error a built and added the missing files. Worked a bit on the home page, I think this is good enough for a release

image

@rodolakis rodolakis marked this pull request as ready for review May 29, 2024 18:17
@rodolakis
Copy link
Collaborator Author

rodolakis commented May 29, 2024 •
edited
Loading

Added "to run this program" section, that includes the alias suggestion:

image

@rodolakis
Copy link
Collaborator Author

@prjemian This is ready now!
FYI I edited the "To run this program" comment (updated the picture) after a final commit to distinguish pip installation from source installation.

prjemian
prjemian reviewed May 29, 2024
View reviewed changes
docs/source/install.rst Outdated Show resolved Hide resolved
prjemian
prjemian reviewed May 29, 2024
View reviewed changes
mdaviz/utils.py Outdated Show resolved Hide resolved
prjemian
prjemian reviewed May 29, 2024
View reviewed changes
docs/source/index.rst Outdated Show resolved Hide resolved
rodolakis and others added 3 commits May 29, 2024 17:13
prjemian
prjemian reviewed May 29, 2024
View reviewed changes
mdaviz/utils.py Outdated Show resolved Hide resolved
@rodolakis rodolakis requested a review from prjemian May 31, 2024 15:33
@prjemian prjemian mentioned this pull request May 31, 2024
Open
prjemian
prjemian approved these changes May 31, 2024
View reviewed changes
Copy link
Collaborator

@prjemian prjemian left a comment

Choose a reason for hiding this comment

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

LGTM

@prjemian prjemian merged commit 3a557f8 into main May 31, 2024
7 checks passed
@prjemian prjemian deleted the update-install-instructions branch May 31, 2024 16:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@prjemian prjemian prjemian approved these changes

Assignees

@rodolakis rodolakis

Labels
documentation Improvements or additions to documentation
Projects
mdaviz
Status: Done
Milestone
v1.0
Development

Successfully merging this pull request may close these issues.

update instruction create start-up script
2 participants
@rodolakis @prjemian