Merge pull request #12 from spdlearn/feat/add-gtm

Add GTM, Open Graph, robots.txt, and llms.txt to docs

Author: bruAristimunha

docs/source/_extra/BingSiteAuth.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0"?>
+<users>
+	<user>EFD667D3D31E1B9BB3E714ADCE472409</user>
+</users>

docs/source/_extra/llms.txt

@@ -0,0 +1,36 @@
+# SPD Learn
+
+> SPD Learn is a pure PyTorch library for geometric deep learning on Symmetric Positive Definite (SPD) matrices. It provides differentiable Riemannian operations, broadcast-compatible layers, and reference implementations of published neural network architectures (SPDNet, TSMNet, EEGSPDNet, TensorCSPNet, PhaseSPDNet, GREEN) for SPD-valued data such as EEG and fMRI covariance matrices.
+
+Key notes for LLMs:
+- Prefer the "API Reference" for exact function signatures, layer parameters, and model constructors.
+- Prefer "Tutorials" for end-to-end workflows (installation through training).
+- The library follows a functional-first design: `spd_learn.functional` (pure functions) -> `spd_learn.modules` (layers) -> `spd_learn.models` (architectures).
+- Requires Python 3.11+ and PyTorch 2.0+.
+- Licensed under BSD-3-Clause.
+
+## Getting Started
+- [Installation](https://spdlearn.org/installation.html): Install via pip, from source, and optional dependencies
+- [User Guide](https://spdlearn.org/user_guide.html): Practical introduction to SPD matrices and building models
+
+## API Reference
+- [API Reference](https://spdlearn.org/api.html): Full API — functional ops, modules (layers), models, and utilities
+
+## Theory & Background
+- [Theory](https://spdlearn.org/theory.html): Mathematical foundations of Riemannian geometry for SPD matrices
+- [Notation](https://spdlearn.org/notation.html): Symbol conventions used in the documentation
+- [Geometric Concepts](https://spdlearn.org/geometric_concepts.html): Key geometric concepts explained
+- [Numerical Stability](https://spdlearn.org/numerical_stability.html): Numerical precision and stability considerations
+- [Glossary](https://spdlearn.org/glossary.html): Definitions of key terms
+
+## Examples & Tutorials
+- [Examples](https://spdlearn.org/generated/auto_examples/index.html): Applied examples and tutorials index
+- [Tutorials](https://spdlearn.org/generated/auto_examples/tutorials/index.html): Step-by-step tutorials for learning SPD Learn
+- [Visualizations](https://spdlearn.org/generated/auto_examples/visualizations/index.html): Visual demonstrations of SPD operations
+- [Applied Examples](https://spdlearn.org/generated/auto_examples/applied_examples/index.html): Real-world applications on EEG, fMRI, and neuroimaging data
+
+## Community
+- [FAQ](https://spdlearn.org/faq.html): Frequently asked questions
+- [Contributing](https://spdlearn.org/contributing.html): How to contribute to SPD Learn
+- [References](https://spdlearn.org/references.html): Academic references and bibliography
+- [GitHub Repository](https://github.com/spdlearn/spd_learn): Source code and issue tracker

docs/source/_extra/robots.txt

@@ -0,0 +1,4 @@
+User-agent: *
+Allow: /
+
+Sitemap: https://spdlearn.org/sitemap.xml

docs/source/_templates/layout.html

@@ -0,0 +1,20 @@
+{% extends "pydata_sphinx_theme/layout.html" %}
+
+{% block extrahead %}
+{{ super() }}
+<!-- Google Tag Manager -->
+<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
+new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
+j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+})(window,document,'script','dataLayer','GTM-NF9467W8');</script>
+<!-- End Google Tag Manager -->
+{% endblock %}
+
+{% block content %}
+<!-- Google Tag Manager (noscript) -->
+<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-NF9467W8"
+height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
+<!-- End Google Tag Manager (noscript) -->
+{{ super() }}
+{% endblock %}

docs/source/conf.py

@@ -26,6 +26,7 @@
     "sphinx_gallery.gen_gallery",
     "matplotlib.sphinxext.plot_directive",
     "sphinx_sitemap",  # SEO: Generate sitemap.xml
+    "sphinxext.opengraph",  # SEO: Open Graph metadata for social previews
 ]
 
 # -- BibTeX configuration -----------------------------------------------------
@@ -302,8 +303,14 @@
 # Point 6: SEO - Add canonical URLs
 html_baseurl = "https://spdlearn.org/"
 
-# Point 7: Prevent duplicate images - don't copy extra files
-html_extra_path = []
+# Point 7: Copy root-level site files (robots.txt, BingSiteAuth.xml, etc.)
+html_extra_path = ["_extra"]
+
+# Point 8: Open Graph metadata for social media previews
+ogp_site_url = "https://spdlearn.org/"
+ogp_image = "https://spdlearn.org/_static/spd_learn.png"
+ogp_description_length = 200
+ogp_type = "website"
 
 # -- Linkcheck configuration -------------------------------------------------
 

pyproject.toml

@@ -60,6 +60,7 @@ docs = [
     'sphinx_gallery',
     'sphinx-copybutton',
     'sphinx-sitemap',
+    'sphinxext-opengraph',
     'sphinxcontrib-bibtex',
     'numpydoc',
     'memory_profiler',