Feature/packaging #4
Merged
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
rcmalli
added
documentation
.bumpversion.cfg
Outdated
There was a problem hiding this comment.
We don't want it anymore?
README.md
Outdated
| 2. Install pre-commit hooks `pre-commit install` | ||
| 3. Eventually build documentation. | ||
| 3. Eventually build documentation by calling. |
README.md
Outdated
| @@ -207,8 +221,8 @@ We rely on a combination of `Black`, `Pylint`, `Mypy`, `Ruff` and `Isort` to enf | |||
| ## Building Documentations | |||
|
|
|||
| 1. Activate your virtual environment. | |||
| 2. install the `quadra` package with at least `doc` version or `dev` version. | |||
| 3. To run the webserver for realtime rendering and editing run `mkdocs serve` and visit `http://localhost:8000/`. | |||
| 2. install the `quadra` package with at least `doc` version. | |||
pyproject.toml
Outdated
| {name = "Refik Can Malli", email = "refikcan.malli@orobix.com"}, | ||
| {name = "Silvia Bianchetti", email = "silvia.bianchetti@orobix.com"}, | ||
| ] | ||
| keywords = ["deep", "learning", "experiment", "lightning", "hydra-core"] |
There was a problem hiding this comment.
It makes sense to separate deep and learning?
There was a problem hiding this comment.
I hope spaces are allowed. For me it is okay to add as deep learning
There was a problem hiding this comment.
If they are not allowed probably deep-learning is better for search
| repository = "https://github.com/orobix/quadra" | ||
|
|
||
| # Adapted from https://realpython.com/pypi-publish-python-package/#version-your-package | ||
| [tool.bumpver] |
lorenzomammana
approved these changes
Jun 1, 2023
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.
Summary
pyproject.yamlfile for library information. It is a step taken to migrate fromsetup.py.README.mdand fix documentation errors.Type of Change
Checklist
Please confirm that the following tasks have been completed:
Note: We need to retag after the merge.