Fixed style of licenses and headlines in documentation.

VHDL · Jan 4, 2021 · 2301a2f · 2301a2f
1 parent 0a94287
commit 2301a2f
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 36 deletions.
diff --git a/doc/Doc-License.rst b/doc/Doc-License.rst
@@ -1,21 +1,9 @@
 .. _DOCLICENSE:
 
-This license applies to the documentation of this project.
-
 .. Note:: This is a local copy of the `Creative Commons - Attribution 4.0 International (CC BY 4.0) <https://creativecommons.org/licenses/by/4.0/legalcode>`__.
 
-.. raw:: html
-
-   <style type="text/css">
-     span.bolditalic {font-weight: bold; font-style: italic; }
-     span.underline {text-decoration: underline; }
-     </style>
-
-.. role:: bolditalic
-   :class: bolditalic
+.. Attention:: This **CC BY 4.0** license applies only to the **documentation** of this project.
 
-.. role:: underline
-   :class: underline
 
 Creative Commons Attribution 4.0 International
 ##############################################
@@ -62,8 +50,7 @@ fullest extent possible.
      encouraged to respect those requests where reasonable.
      `More considerations for the public <http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensees>`__.
 
-Creative Commons Attribution 4.0 International Public License
-*************************************************************
+:xlarge:`Creative Commons Attribution 4.0 International Public License`
 
 By exercising the Licensed Rights (defined below), You accept and agree to be
 bound by the terms and conditions of this Creative Commons Attribution 4.0

diff --git a/doc/Code-License.rst → doc/License.rst b/doc/Code-License.rst → doc/License.rst
@@ -1,15 +1,15 @@
 .. _SRCLICENSE:
 
-This license applies to the source code of this project.
-
 .. Note:: This is a local copy of the `Apache License Version 2.0 <http://www.apache.org/licenses/LICENSE-2.0>`__.
 
+.. Attention:: This **Apache License, 2.0** applies to all **source and configuration files of project**, **except documentation**.
+
 Apache License 2.0
 ##################
 
 Version 2.0, January 2004
 
-**TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION**
+:xlarge:`TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION`
 
 
 1. Definitions.
@@ -117,7 +117,7 @@ incurred by, or claims asserted against, such Contributor by reason of your acce
 
 ----------------------------------------------------------------------------------------------------------------------------------------------------------------
 
-**Appendix: How to apply the Apache License to your work**
+:xlarge:`Appendix: How to apply the Apache License to your work`
 
 To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying
 information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or

diff --git a/doc/index.rst b/doc/index.rst
@@ -155,8 +155,10 @@ License
    :hidden:
 
    ChangeLog/index
-   Code-License
+   License
    Doc-License
    Glossary
    genindex
+
+.. #
    py-modindex
diff --git a/doc/prolog.inc b/doc/prolog.inc
@@ -9,6 +9,25 @@
 
    <br />
 
+.. # define horizontal line for HTML
 .. |hr| raw:: html
 
    <hr />
+
+.. # define additional CSS based styles and ReST roles for HTML
+.. raw:: html
+
+   <style type="text/css">
+     span.bolditalic {font-weight: bold; font-style: italic; }
+     span.underline {text-decoration: underline; }
+     span.xlarge {font-size: x-large; }
+   </style>
+
+.. role:: bolditalic
+   :class: bolditalic
+
+.. role:: underline
+   :class: underline
+
+.. role:: xlarge
+   :class: xlarge
diff --git a/doc/pyVHDLModel/index.rst b/doc/pyVHDLModel/index.rst
@@ -1,13 +1,3 @@
 .. toctree::
 
    pyVHDLModel
-
-
-------------------
-
-.. automodule:: pyVHDLModel
-   :show-inheritance:
-   :members:
-   :undoc-members:
-.. #
-   :inherited-members:
diff --git a/pyVHDLModel/VHDLModel.py b/pyVHDLModel/VHDLModel.py
@@ -35,9 +35,6 @@
 # ==============================================================================
 #
 """
-pyVHDLModel
-###########
-
 :copyright: Copyright 2007-2021 Patrick Lehmann - Bötzingen, Germany
 :license: Apache License, Version 2.0
 

diff --git a/pyVHDLModel/__init__.py b/pyVHDLModel/__init__.py
@@ -35,9 +35,6 @@
 # ==============================================================================
 #
 """
-pyVHDLModel
-###########
-
 :copyright: Copyright 2007-2021 Patrick Lehmann - Bötzingen, Germany
 :license: Apache License, Version 2.0
 """