Skip to content

Commit

Permalink
docs: replace LICENSE.txt with LICENSE.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
eine committed Aug 8, 2020
1 parent 1f45cc0 commit a732ff9
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 63 deletions.
15 changes: 15 additions & 0 deletions LICENSE.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
**VUnit**, except for the projects below, is released under the terms of
`Mozilla Public License, v. 2.0`_. |copy| 2014-2020 Lars Asplund, [email protected].

The following libraries are `redistributed`_ with VUnit for your convenience:

* **OSVVM** (``vunit/vhdl/osvvm``): these files are licensed under the terms of `Apache License, v 2.0`_, |copy| 2010 - 2020 by `SynthWorks Design Inc`_. All rights reserved.

* **JSON-for-VHDL** (``vunit/vhdl/JSON-for-VHDL``): these files are licensed under the terms of `Apache License, v 2.0`_, |copy| 2015 - 2020 Patrick Lehmann.

.. |copy| unicode:: U+000A9 .. COPYRIGHT SIGN
.. _redistributed: https://github.com/VUnit/vunit/blob/master/.gitmodules
.. _Mozilla Public License, v. 2.0: http://mozilla.org/MPL/2.0/
.. _ARTISTIC License: http://www.perlfoundation.org/artistic_license_2_0
.. _Apache License, v 2.0: http://www.apache.org/licenses/LICENSE-2.0
.. _SynthWorks Design Inc: http://www.synthworks.com
15 changes: 0 additions & 15 deletions LICENSE.txt

This file was deleted.

36 changes: 3 additions & 33 deletions docs/about.rst
Original file line number Diff line number Diff line change
Expand Up @@ -135,8 +135,8 @@ Support
Any bug reports, feature requests or questions about the usage of VUnit
can be made by creating a `new issue`_.

Credits
-------
Credits and license
-------------------

- Founders:

Expand All @@ -160,34 +160,7 @@ Credits

- Continuous Integration (CI)

License
-------

.. |copy| unicode:: U+000A9 .. COPYRIGHT SIGN

VUnit
*****

VUnit, except for the projects below, is released under the terms of
`Mozilla Public License, v. 2.0`_.

|copy| 2014-2020 Lars Asplund, [email protected].

OSVVM
*****

OSVVM is redistributed (`vunit/vhdl/osvvm <https://github.com/VUnit/vunit/tree/master/vunit/vhdl>`_) with VUnit for your convenience. These
files are licensed under the terms of `Apache License, v 2.0`_.

|copy| 2010 - 2020 by SynthWorks Design Inc. All rights reserved.

JSON-for-VHDL
*************

JSON-for-VHDL is redistributed (`vunit/vhdl/JSON-for-VHDL <https://github.com/VUnit/vunit/tree/master/vunit/vhdl>`_) with VUnit for your convenience. These
files are licensed under the terms of `Apache License, v 2.0`_.

|copy| 2015 - 2020 Patrick Lehmann.
.. include:: license.rst

.. _xUnit: http://en.wikipedia.org/wiki/XUnit
.. _Jenkins: http://jenkins-ci.org/
Expand All @@ -201,6 +174,3 @@ files are licensed under the terms of `Apache License, v 2.0`_.
.. _an introduction to unit testing (6 min): https://www.youtube.com/watch?v=PZuBqcxS8t4
.. _short introduction to VUnit (12 min): https://www.youtube.com/watch?v=D8s_VLD91tw
.. _new issue: https://github.com/VUnit/vunit/issues/new
.. _Mozilla Public License, v. 2.0: http://mozilla.org/MPL/2.0/
.. _ARTISTIC License: http://www.perlfoundation.org/artistic_license_2_0
.. _Apache License, v 2.0: http://www.apache.org/licenses/LICENSE-2.0
2 changes: 1 addition & 1 deletion tests/lint/test_license.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ def test_that_a_valid_license_exists_in_source_files_and_that_global_licensing_i
def test_that_license_file_matches_vunit_license_text(self):
with catch_warnings():
simplefilter("ignore", category=DeprecationWarning)
with (ROOT / "LICENSE.txt").open("rU") as lic:
with (ROOT / "LICENSE.rst").open("rU") as lic:
self.assertEqual(lic.read(), license_text())

def _check_license(self, code, file_name):
Expand Down
7 changes: 6 additions & 1 deletion tools/build_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,23 @@
from pathlib import Path
import sys
from sys import argv
from shutil import copyfile
from create_release_notes import create_release_notes
from docs_utils import examples, get_theme


DROOT = Path(__file__).parent.parent / 'docs'


def main():
"""
Build documentation/website
"""
create_release_notes()
examples()
copyfile(str(DROOT / '..' / 'LICENSE.rst'), str(DROOT / 'license.rst'))
get_theme(
Path(__file__).parent.parent / "docs",
DROOT,
"https://codeload.github.com/buildthedocs/sphinx.theme/tar.gz/v0"
)
check_call(
Expand Down
24 changes: 11 additions & 13 deletions vunit/about.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,21 @@ def license_text():
"""
Returns licence text
"""
return """VUnit
-----
return """**VUnit**, except for the projects below, is released under the terms of
`Mozilla Public License, v. 2.0`_. |copy| 2014-2020 Lars Asplund, [email protected].
VUnit except for OSVVM (see below) is released under the terms of
Mozilla Public License, v. 2.0.
The following libraries are `redistributed`_ with VUnit for your convenience:
Copyright (c) 2014-2020, Lars Asplund [email protected]
* **OSVVM** (``vunit/vhdl/osvvm``): these files are licensed under the terms of `Apache License, v 2.0`_, |copy| 2010 - 2020 by `SynthWorks Design Inc`_. All rights reserved.
OSVVM
-----
* **JSON-for-VHDL** (``vunit/vhdl/JSON-for-VHDL``): these files are licensed under the terms of `Apache License, v 2.0`_, |copy| 2015 - 2020 Patrick Lehmann.
OSVVM is redistributed as a submodule to VUnit for your convenience. OSVVM and derivative work
located under examples/vhdl/osvvm_integration/src are licensed under the terms of Artistic License 2.0.
Copyright (c) 2006-2016, SynthWorks Design Inc http://www.synthworks.com
.. |copy| unicode:: U+000A9 .. COPYRIGHT SIGN
.. _redistributed: https://github.com/VUnit/vunit/blob/master/.gitmodules
.. _Mozilla Public License, v. 2.0: http://mozilla.org/MPL/2.0/
.. _ARTISTIC License: http://www.perlfoundation.org/artistic_license_2_0
.. _Apache License, v 2.0: http://www.apache.org/licenses/LICENSE-2.0
.. _SynthWorks Design Inc: http://www.synthworks.com
"""


Expand All @@ -54,8 +54,6 @@ def doc():
welcome. Read our `contribution guide
<https://vunit.github.io/contributing.html>`__ to get started.
License
=======
"""
+ license_text()
)
Expand Down

0 comments on commit a732ff9

Please sign in to comment.