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

Move example notebooks to docs/examples #96

Merged
merged 1 commit into from
Dec 4, 2024
Merged

Conversation

wkearn
Copy link
Contributor

@wkearn wkearn commented Nov 29, 2024

Fixes #81

@wkearn wkearn added the documentation Improvements or additions to documentation label Nov 29, 2024
@wkearn
Copy link
Contributor Author

wkearn commented Nov 29, 2024

@Teschl, @bgailleton: is this a good idea? In addition to cleaning up the URLs (#81), this simplifies the build process, because we don't have to copy the notebooks into the docs directory.

On the other hand, it seems like the top-level examples/ directory is a common pattern in Python, so I could see an argument for keeping that around.

@Teschl
Copy link
Contributor

Teschl commented Nov 30, 2024

I think it's fine. Especially because they are kept without outputs in the repo, they only have them on the website where the examples are easy to find anyway.

@wkearn wkearn merged commit 702a6e1 into TopoToolbox:main Dec 4, 2024
7 checks passed
@bgailleton
Copy link
Contributor

Ah sorry i did not notice the tag. I do not see why it would be a problem as long as the README.md points to the example folder explicitly!

@wkearn wkearn mentioned this pull request Dec 5, 2024
wkearn added a commit to Teschl/pytopotoolbox that referenced this pull request Dec 5, 2024
Following the changes in TopoToolbox#96
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.

Rework URLs for docs
3 participants