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

Update docs/installation.rst #667

Merged
merged 2 commits into from
Aug 25, 2023
Merged

Update docs/installation.rst #667

merged 2 commits into from
Aug 25, 2023

Conversation

jeongyoonlee
Copy link
Collaborator

@jeongyoonlee jeongyoonlee commented Aug 24, 2023

Proposed changes

This PR fixes #666. It updates the installation instructions in docs/installation.rst with updates in #637. It also fixes the broken the download image in README.md and formatting warnings in docs/*.rst.

Types of changes

What types of changes does your code introduce to CausalML?
Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have read the CONTRIBUTING doc
  • I have signed the CLA
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

Further comments

N/A

@jeongyoonlee jeongyoonlee added the documentation Improvements or additions to documentation label Aug 24, 2023
@jeongyoonlee jeongyoonlee changed the title Update the readthedocs installation page Update docs/installation.rst Aug 24, 2023
@vincewu51
Copy link
Collaborator

Hi Jeong, it seems some build has failed. Could you please rebase and re-run the build?

@jeongyoonlee
Copy link
Collaborator Author

Hi Jeong, it seems some build has failed. Could you please rebase and re-run the build?

Done!

@vincewu51
Copy link
Collaborator

668 is merged. Please rebase and it should solve the build failure.

@jeongyoonlee
Copy link
Collaborator Author

Done! Now all builds succeeded except PyPI installations, which we should separate and run only for new version releases.

@vincewu51 vincewu51 merged commit 1db136f into master Aug 25, 2023
10 of 13 checks passed
@jeongyoonlee jeongyoonlee deleted the jeong/update_docs branch August 25, 2023 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Installation instructions on docs/ are outdated
2 participants