docs: add a license notice to the documentation (resolve #7)

hearot · Jun 18, 2020 · 54bf64e · 54bf64e
1 parent 0054e2a
commit 54bf64e
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,7 +8,8 @@
    - Add a flowchart for `calendar_bot.py` ([f7b41b594d62a2874a280bb93b4b1ea419ea35d1](https://github.com/hearot/pyrubrum/commit/f7b41b594d62a2874a280bb93b4b1ea419ea35d1))
    - Add a flowchart for `hitchhiker_bot.py` ([3f7057244f3e1c868e0e7b00f04e39d481468a6d](https://github.com/hearot/pyrubrum/commit/3f7057244f3e1c868e0e7b00f04e39d481468a6d))
    - Add a flowchart for `sample_bot.py` ([a698a4f1c7b85640011f861b9f2ae6ffa5dbd001](https://github.com/hearot/pyrubrum/commit/a698a4f1c7b85640011f861b9f2ae6ffa5dbd001))
-   - Add a reference to the author's GPG public key
+   - Add a license notice to the documentation (resolve #7)
+   - Add a reference to the author's GPG public key ([0054e2af66d239d2d60aa8c2e26fe7f32747dfaa](https://github.com/hearot/pyrubrum/commit/0054e2af66d239d2d60aa8c2e26fe7f32747dfaa))
    - Add a simple glossary ([0000e5ecc76f27f66833a28ef67836b5a338a353](https://github.com/hearot/pyrubrum/commit/0000e5ecc76f27f66833a28ef67836b5a338a353))
    - Add a simple quickstart menu ([3b4e5c7581ec4457bc8427068524954ec4920418](https://github.com/hearot/pyrubrum/commit/3b4e5c7581ec4457bc8427068524954ec4920418))
    - Add a tip for opening a feature request ([909dfff2923e8b551d4500f48223659cd1d97ec4](https://github.com/hearot/pyrubrum/commit/909dfff2923e8b551d4500f48223659cd1d97ec4))

diff --git a/FEATURES.md b/FEATURES.md
@@ -4,7 +4,8 @@
    - Add a flowchart for `calendar_bot.py` ([f7b41b594d62a2874a280bb93b4b1ea419ea35d1](https://github.com/hearot/pyrubrum/commit/f7b41b594d62a2874a280bb93b4b1ea419ea35d1))
    - Add a flowchart for `hitchhiker_bot.py` ([3f7057244f3e1c868e0e7b00f04e39d481468a6d](https://github.com/hearot/pyrubrum/commit/3f7057244f3e1c868e0e7b00f04e39d481468a6d))
    - Add a flowchart for `sample_bot.py` ([a698a4f1c7b85640011f861b9f2ae6ffa5dbd001](https://github.com/hearot/pyrubrum/commit/a698a4f1c7b85640011f861b9f2ae6ffa5dbd001))
-   - Add a reference to the author's GPG public key
+   - Add a license notice to the documentation (resolve #7)
+   - Add a reference to the author's GPG public key ([0054e2af66d239d2d60aa8c2e26fe7f32747dfaa](https://github.com/hearot/pyrubrum/commit/0054e2af66d239d2d60aa8c2e26fe7f32747dfaa))
    - Add a simple glossary ([0000e5ecc76f27f66833a28ef67836b5a338a353](https://github.com/hearot/pyrubrum/commit/0000e5ecc76f27f66833a28ef67836b5a338a353))
    - Add a simple quickstart menu ([3b4e5c7581ec4457bc8427068524954ec4920418](https://github.com/hearot/pyrubrum/commit/3b4e5c7581ec4457bc8427068524954ec4920418))
    - Add a tip for opening a feature request ([909dfff2923e8b551d4500f48223659cd1d97ec4](https://github.com/hearot/pyrubrum/commit/909dfff2923e8b551d4500f48223659cd1d97ec4))

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -62,7 +62,14 @@
 copyright = "2020, Hearot"
 author = pyrubrum.__author__
 
-root_files = ["CHANGELOG.md", "CODE_OF_CONDUCT.md", "README.md", "SECURITY.md"]
+root_files = [
+    "CHANGELOG.md",
+    "CODE_OF_CONDUCT.md",
+    "LICENSE",
+    "NOTICE",
+    "README.md",
+    "SECURITY.md",
+]
 copies = root_files + ["FEATURES.md"]
 
 for root_file in root_files:
@@ -150,6 +157,7 @@
 html_favicon = "_static/assets/pink_icon.ico"
 
 html_logo = "_static/assets/mark_logo.png"
+latex_logo = "_static/assets/mark_logo.png"
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
@@ -161,10 +169,16 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
+html_show_sourcelink = True
+
+html_show_copyright = True
+
 html_static_path = ["_static"]
 
 intersphinx_mapping = {
     "pyrogram": ("https://docs.pyrogram.org/", None),
     "python": ("https://docs.python.org/3", None),
     "redis": ("https://redis-py.readthedocs.io/en/stable/", None),
 }
+
+latex_engine = "xelatex"
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -86,5 +86,6 @@ Welcome to Pyrubrum
     Code of Conduct <CODE_OF_CONDUCT>
     flowchart
     glossary
+    license
     Read me <README>
     SECURITY
diff --git a/docs/source/license.rst b/docs/source/license.rst
@@ -0,0 +1,15 @@
+License
+=======
+
+.. figure:: https://www.gnu.org/graphics/gplv3-with-text-136x68.png
+    :align: left
+
+Pyrubrum is free software: you can redistribute it and/or modify
+it under the terms of the `GNU General Public License <https://github.com/hearot/pyrubrum/blob/dev/LICENSE>`_
+as published by the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+Pyrubrum is distributed in the hope that it will be useful,
+but *WITHOUT ANY WARRANTY*; without even the implied warranty of
+*MERCHANTABILITY* or *FITNESS FOR A PARTICULAR PURPOSE*. See the
+`GNU General Public License <https://github.com/hearot/pyrubrum/blob/dev/LICENSE>`_ for more details.