adding layout.html template

Author: dario-coscia

docs/source/_contributing.rst

@@ -4,7 +4,7 @@ Contributing to PINA
 First off, thanks for taking the time to contribute to **PINA**! 🎉 Your help makes the project better for everyone. This document outlines the process for contributing, reporting issues, suggesting features, and submitting pull requests.
 
 Table of Contents
-=================
+------------------------
 
 1. `How to Contribute`_
 2. `Reporting Bugs`_
@@ -14,7 +14,7 @@ Table of Contents
 6. `Community Standards`_
 
 How to Contribute
-=================
+------------------------
 
 You can contribute in several ways:
 
@@ -26,7 +26,7 @@ You can contribute in several ways:
 We encourage all contributions, big or small!
 
 Reporting Bugs
-==============
+------------------------
 
 If you find a bug, please open an `issue <https://github.com/mathLab/PINA/issues>`_ and include:
 
@@ -38,7 +38,7 @@ If you find a bug, please open an `issue <https://github.com/mathLab/PINA/issues
 - Environment info (OS, Python version, dependencies, etc.)
 
 Suggesting Enhancements
-=======================
+------------------------
 
 We welcome new ideas! If you have an idea to improve PINA:
 
@@ -50,7 +50,7 @@ We welcome new ideas! If you have an idea to improve PINA:
 3. If you are not sure about (something of) the enhancement, we suggest opening a discussion to collaborate on it with the PINA community.
 
 Pull Request Process
-====================
+------------------------
 
 Before submitting a PR:
 
@@ -87,14 +87,14 @@ Pull Request Checklist
 4. Pull request is linked to an open issue (if applicable)
 
 Code Style & Guidelines
-=======================
+------------------------
 
 - Follow PEP8 for Python code.
 - Use descriptive commit messages (e.g. ``Fix parser crash on empty input``).
 - Write clear docstrings for public classes, methods, and functions.
 - Keep functions small and focused; do one thing and do it well.
 
 Community Standards
-===================
+------------------------
 
 By participating in this project, you agree to abide by our Code of Conduct. We are committed to maintaining a welcoming and inclusive community.

docs/source/_templates/layout.html

@@ -0,0 +1,17 @@
+{% extends "!layout.html" %}
+
+{%- block footer %}
+<footer class="footer" style="border-top: 1px solid #ccc; padding-top: 10px">
+    <div class="container">
+        <div id="credits" style="width: 50%; float: left">
+            <p>
+                {% trans copyright=copyright|e %}&#169; Copyright {{ copyright }}, <a
+                    href="https://github.com/mathLab/PINA/">PINA Developers</a>.{% endtrans %}<br />
+                Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and the <a
+                    href="https://pydata-sphinx-theme.readthedocs.io/en/stable/">PyData Theme</a>.<br />
+            </p>
+        </div>
+    </div>
+    </div>
+</footer>
+{%- endblock %}

docs/source/conf.py

@@ -14,21 +14,19 @@
 
 import sys
 import os
-import sphinx_rtd_theme
+import time
 import importlib.metadata
 
 
 # -- Project information -----------------------------------------------------
 _DISTRIBUTION_METADATA = importlib.metadata.metadata("pina-mathlab")
 project = _DISTRIBUTION_METADATA["Name"]
-copyright = _DISTRIBUTION_METADATA["License-File"]
+copyright = f'2021-{time.strftime("%Y")}'
 author = "PINA Contributors"
 version = _DISTRIBUTION_METADATA["Version"]
 
 
-sys.path.insert(
-    0, os.path.abspath("../sphinx_extensions")
-)
+sys.path.insert(0, os.path.abspath("../sphinx_extensions"))
 
 # -- General configuration ------------------------------------------------
 
@@ -54,7 +52,7 @@
 exclude_patterns = ["build", "docstrings", "nextgen", "Thumbs.db", ".DS_Store"]
 
 # The reST default role (used for this markup: `text`) to use for all documents.
-# default_role = 'literal'
+default_role = "literal"
 
 # Generate the API documentation when building
 autosummary_generate = True
@@ -71,21 +69,6 @@
     ),
 }
 
-# nitpicky = True
-# nitpick_ignore = [
-#     ("py:meth", "lightning.pytorch.core.module.LightningModule.log"),
-#     ("py:meth", "lightning.pytorch.core.module.LightningModule.log_dict"),
-#     ("py:exc", "MisconfigurationException"),
-#     ("py:func", "torch.inference_mode"),
-#     ("py:func", "torch.no_grad"),
-#     ("py:class", "torch.utils.data.DistributedSampler"),
-#     ("py:class", "pina.model.layers.convolution.BaseContinuousConv"),
-#     ("py:class", "Module"),
-#     ("py:class", "torch.nn.modules.loss._Loss"),  # TO FIX
-#     ("py:class", "torch.optim.LRScheduler"),  # TO FIX
-# ]
-
-
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
@@ -148,13 +131,6 @@
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-# html_theme_options = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-# html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
 html_logo = "index_files/PINA_logo.png"
 html_theme_options = {
     "icon_links": [
@@ -183,6 +159,10 @@
     "header_links_before_dropdown": 8,
 }
 
+html_context = {
+    "default_mode": "light",
+}
+
 # If not ''i, a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
 html_last_updated_fmt = "%b %d, %Y"
@@ -256,7 +236,6 @@
         "PINA Documentation",
         author,
         "pina",
-        "One line description of project.",
         "Miscellaneous",
     ),
 ]