Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
This PR adds example Jupyter notebooks to the documentation website at https://causalml.readthedocs.io/.
Types of changes
What types of changes does your code introduce to CausalML?
Put an
x
in the boxes that applyChecklist
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.Further comments
This PR moves the
examples
folder from the project root todocs/
because thenbsphinx
extension cannot render notebook files outside thedocs/
folder. There is another extension,nbsphinx-link
, that enables rendering notebooks outsidedocs
, but it requires creating one.nblink
for each notebook file to be rendered. Also thenbsphinx-link
project has been inactive in the past 4 years.In short, I found moving the entire
examples
folder is the simplest solution.