Change project structure for Poetry and Jupyter-Book ocmpatibility #10
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
carlocagnetta
commented
Feb 27, 2024
MischaPanch
requested changes
Feb 27, 2024
{{cookiecutter.project_name}}/docs/02_notebooks/config_example.ipynb
Outdated
Show resolved
Hide resolved
{{cookiecutter.project_name}}/src/{{cookiecutter.project_name}}/sample_module.py
Outdated
Show resolved
Hide resolved
| @@ -10,8 +10,7 @@ | |||
| "In this library template, notebooks will be executed with pytest (thus on every\n", | |||
| "commit in your CI/CD pipeline). The results of the executions will be saved to the docs directory and converted to\n", | |||
| "static websites through nbconvert. The static websites are then added to the documentation under the\n", | |||
| "_Guides and Tutorials_ section. These websites will be deployed to gitlab/github pages on push to develop.\n", | |||
| "For azure-devops, the CI pipeline currently does not include a deployment of the pages - pull requests are welcome :)" | |||
| "_Guides and Tutorials_ section. These websites will be deployed to Github pages on push to develop." | |||
There was a problem hiding this comment.
The output of one of the functions mentions pylint, pls change that text
Also, pls demonstrate how to use references in the nb (like in tianshou)
There was a problem hiding this comment.
@carlocagnetta I did the first part, could you add the references pls?
There was a problem hiding this comment.
Merging this meanwhile, you can go ahead and use this for the new project!
{{cookiecutter.project_name}}/docs/02_notebooks/library_example.ipynb
Outdated
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Virtual env dealt by Poetry
Automatic API documentation
Documentation built in Jupyter-Books
Removed venv
Removed Gitlab CI
Removed Azure Pipeline