Skip to content

Commit 3726e02

Browse files
authoredApr 24, 2020
Convert License to reStructuredText (#181)
* Convert License to reStructuredText (Cookiecutter) * Update documentation about License * Use active voice in table about documentation files * Convert License to reStructuredText cjolowicz/cookiecutter-hypermodern-python-instance#128
1 parent e891480 commit 3726e02

File tree

7 files changed

+27
-31
lines changed

7 files changed

+27
-31
lines changed
 

‎LICENSE ‎LICENSE.rst

+9-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
MIT License
2+
===========
23

3-
Copyright (c) 2020 Claudio Jolowicz
4+
Copyright © 2020 Claudio Jolowicz
45

56
Permission is hereby granted, free of charge, to any person obtaining a copy
67
of this software and associated documentation files (the "Software"), to deal
@@ -12,10 +13,10 @@ furnished to do so, subject to the following conditions:
1213
The above copyright notice and this permission notice shall be included in all
1314
copies or substantial portions of the Software.
1415

15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
16+
**The software is provided "as is", without warranty of any kind, express or
17+
implied, including but not limited to the warranties of merchantability,
18+
fitness for a particular purpose and noninfringement. In no event shall the
19+
authors or copyright holders be liable for any claim, damages or other
20+
liability, whether in an action of contract, tort or otherwise, arising from,
21+
out of or in connection with the software or the use or other dealings in the
22+
software.**

‎docs/guide.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -1531,15 +1531,15 @@ Stand-alone documents
15311531
---------------------
15321532

15331533
The project repository contains several documentation files
1534-
written in reStructuredText_ and plain text:
1534+
written in reStructuredText_:
15351535

15361536
======================= ============================================
15371537
File Contents
15381538
======================= ============================================
15391539
``README.rst`` Project description for GitHub and PyPI
15401540
``CONTRIBUTING.rst`` Contributor Guide
15411541
``CODE_OF_CONDUCT.rst`` Code of Conduct
1542-
``LICENSE`` License
1542+
``LICENSE.rst`` License
15431543
======================= ============================================
15441544

15451545

@@ -1557,9 +1557,9 @@ File Contents
15571557
====================== =======================================================
15581558
``conf.py`` Sphinx configuration file
15591559
``index.rst`` Master document
1560-
``contributing.rst`` Contributor Guide (included from ``CONTRIBUTING.rst``)
1561-
``codeofconduct.rst`` Code of Conduct (included from ``CODE_OF_CONDUCT.rst``)
1562-
``license.rst`` License (included from ``LICENSE``)
1560+
``contributing.rst`` Contributor Guide (includes ``CONTRIBUTING.rst``)
1561+
``codeofconduct.rst`` Code of Conduct (includes ``CODE_OF_CONDUCT.rst``)
1562+
``license.rst`` License (includes ``LICENSE.rst``)
15631563
``reference.rst`` API documentation
15641564
``requirements.txt`` Build dependencies for `Read the Docs`_
15651565
====================== =======================================================

‎docs/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Hypermodern Python Cookiecutter
99
guide
1010
contributing
1111
Code of Conduct <codeofconduct>
12-
license
12+
License <license>
1313
Changelog <https://github.com/cjolowicz/cookiecutter-hypermodern-python/releases>
1414

1515
.. include:: ../README.rst

‎docs/license.rst

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1 @@
1-
License
2-
=======
3-
4-
.. include:: ../LICENSE
1+
.. include:: ../LICENSE.rst
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
MIT License
2+
===========
23

3-
Copyright (c) 2020 {{cookiecutter.author}}
4+
Copyright © 2020 {{cookiecutter.author}}
45

56
Permission is hereby granted, free of charge, to any person obtaining a copy
67
of this software and associated documentation files (the "Software"), to deal
@@ -12,10 +13,10 @@ furnished to do so, subject to the following conditions:
1213
The above copyright notice and this permission notice shall be included in all
1314
copies or substantial portions of the Software.
1415

15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
16+
**The software is provided "as is", without warranty of any kind, express or
17+
implied, including but not limited to the warranties of merchantability,
18+
fitness for a particular purpose and noninfringement. In no event shall the
19+
authors or copyright holders be liable for any claim, damages or other
20+
liability, whether in an action of contract, tort or otherwise, arising from,
21+
out of or in connection with the software or the use or other dealings in the
22+
software.**

‎{{cookiecutter.project_name}}/docs/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
reference
99
contributing
1010
Code of Conduct <codeofconduct>
11-
license
11+
License <license>
1212
Changelog <https://github.com/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}/releases>
1313

1414
.. include:: ../README.rst
Original file line numberDiff line numberDiff line change
@@ -1,4 +1 @@
1-
License
2-
=======
3-
4-
.. include:: ../LICENSE
1+
.. include:: ../LICENSE.rst

0 commit comments

Comments
 (0)
Please sign in to comment.