diff --git a/LICENSE b/LICENSE deleted file mode 100644 index bd43c18..0000000 --- a/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2021-2021 Vasilis Sioros (billsioros) - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/README.md b/README.md index a7060b3..1a55d3f 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ src="https://codecov.io/gh/billsioros/cookiecutter-pypackage-instance/branch/master/graph/badge.svg?token=coLOL0j6Ap" alt="Test Coverage"/> - + - + + + + + +
## Example Usage diff --git a/docs/LICENSE.md b/docs/LICENSE.md index d6d8ca4..09a9675 100644 --- a/docs/LICENSE.md +++ b/docs/LICENSE.md @@ -1,4 +1,4 @@ - + diff --git a/docs/src/cookiecutter_pypackage_instance.md b/docs/src/cookiecutter_pypackage_instance.md new file mode 100644 index 0000000..8a3bc69 --- /dev/null +++ b/docs/src/cookiecutter_pypackage_instance.md @@ -0,0 +1,3 @@ +# Documentation for `cookiecutter-pypackage-instance` + +::: cookiecutter_pypackage_instance.cookiecutter_pypackage_instance diff --git a/mkdocs.yml b/mkdocs.yml index be9ae46..e5f9768 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,14 +1,16 @@ -site_name: cookiecutter-pypackage-instance +site_name: Cookiecutter Pypackage Instance site_description: "🐍 An awesome python package by the name `Cookiecutter Pypackage Instance`" site_url: "https://billsioros.github.io/cookiecutter-pypackage-instance/" repo_url: "https://github.com/billsioros/cookiecutter-pypackage-instance" edit_uri: "edit/master/docs/" repo_name: "billsioros/cookiecutter-pypackage-instance" copyright: | - Copyright © 2021 Vasilis Sioros + Copyright © 2021-2021 Vasilis Sioros nav: - Overview: index.md + - Code Reference: + - Cookiecutter Pypackage Instance: src/cookiecutter_pypackage_instance.md - Contributing: - Contributing Guidelines: CONTRIBUTING.md - Code Of Conduct: CODE_OF_CONDUCT.md diff --git a/pyproject.toml b/pyproject.toml index 05a160b..84f92bc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -107,6 +107,7 @@ known_first_party = "cookiecutter_pypackage_instance" [tool.black] line-length = 99 target-version = ["py37", "py38"] +skip-string-normalization = true [tool.mypy] files = ["src/cookiecutter_pypackage_instance"]