From 7b6fb6a199c420ad1f408eff26d0a9c3073230ba Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Chapoton?= <chapoton@unistra.fr>
Date: Fri, 10 Jan 2025 16:27:46 +0100
Subject: [PATCH] adding operads to reference manual

---
 src/doc/en/reference/index.rst         |  1 +
 src/doc/en/reference/operads/conf.py   | 87 ++++++++++++++++++++++++++
 src/doc/en/reference/operads/index.rst | 19 ++++++
 3 files changed, 107 insertions(+)
 create mode 100644 src/doc/en/reference/operads/conf.py
 create mode 100644 src/doc/en/reference/operads/index.rst

diff --git a/src/doc/en/reference/index.rst b/src/doc/en/reference/index.rst
index 646f7c76680..8fca1f333aa 100644
--- a/src/doc/en/reference/index.rst
+++ b/src/doc/en/reference/index.rst
@@ -76,6 +76,7 @@ Mathematical Structures
 * :doc:`Semirings <semirings/index>`
 * :doc:`Rings <rings/index>`
 * :doc:`Algebras <algebras/index>`
+* :doc:`Operads <operads/index>`
 
 Discrete Mathematics
 --------------------
diff --git a/src/doc/en/reference/operads/conf.py b/src/doc/en/reference/operads/conf.py
new file mode 100644
index 00000000000..c7adc1da994
--- /dev/null
+++ b/src/doc/en/reference/operads/conf.py
@@ -0,0 +1,87 @@
+# nodoctest
+# Sage documentation build configuration file, created by
+# sphinx-quickstart on Thu Aug 21 20:15:55 2008.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# The contents of this file are pickled, so don't put values in the namespace
+# that aren't pickleable (module imports are okay, they're removed automatically).
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import os
+from sage.env import SAGE_DOC_SRC, SAGE_DOC
+from sage_docbuild.conf import release, exclude_patterns
+from sage_docbuild.conf import *
+
+
+for tag in feature_tags():
+    tags.add(tag)
+
+
+# Add any paths that contain custom static files (such as style sheets),
+# relative to this directory to html_static_path. They are copied after the
+# builtin static files, so a file named "default.css" will overwrite the
+# builtin "default.css". html_common_static_path imported from sage_docbuild.conf
+# contains common paths.
+html_static_path = [] + html_common_static_path
+
+ref_src = os.path.join(SAGE_DOC_SRC, 'en', 'reference')
+ref_out = os.path.join(SAGE_DOC, 'html', 'en', 'reference')
+
+# We use the main document's title, if we can find it.
+rst_file = open('index.rst', 'r')
+rst_lines = rst_file.read().splitlines()
+rst_file.close()
+
+title = ''
+for i in range(len(rst_lines)):
+    if rst_lines[i].startswith('==') and i > 0:
+        title = rst_lines[i-1].strip()
+        break
+
+# Otherwise, we use this directory's name.
+name = os.path.basename(os.path.abspath('.'))
+if not title:
+    title = name.capitalize()
+title = title.replace('`', '$')
+
+# We use the directory's name to add small view/edit buttons.
+html_theme_options.update({
+  'source_view_link': os.path.join(source_repository, f'blob/develop/src/doc/en/reference/{name}', '{filename}'),
+  'source_edit_link': os.path.join(source_repository, f'edit/develop/src/doc/en/reference/{name}', '{filename}'),
+})
+
+# General information about the project.
+project = title
+
+# The name for this set of Sphinx documents.
+html_title = title
+html_short_title = title
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = name
+
+# Grouping the document tree into LaTeX files. List of tuples (source
+# start file, target name, title, author, document class
+# [howto/manual]).
+latex_documents = [
+  ('index', name + '.tex', title,
+   'The Sage Development Team', 'manual')
+]
+
+latex_elements['hyperref'] = r"""
+\usepackage{xr}
+\externaldocument[../references/]{../references/references}
+% Include hyperref last.
+\usepackage{hyperref}
+% Fix anchor placement for figures with captions.
+\usepackage{hypcap}% it must be loaded after hyperref.
+% Set up styles of URL: it should be placed after hyperref.
+\urlstyle{same}"""
+
+#Ignore all .rst in the _sage subdirectory
+exclude_patterns = exclude_patterns + ['_sage']
+
+multidocs_is_master = False
diff --git a/src/doc/en/reference/operads/index.rst b/src/doc/en/reference/operads/index.rst
new file mode 100644
index 00000000000..5985425f2db
--- /dev/null
+++ b/src/doc/en/reference/operads/index.rst
@@ -0,0 +1,19 @@
+Operads
+========
+
+Examples of operads
+-------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   sage/operads/associative_operad
+   sage/operads/commutative_operad
+   sage/operads/dendriform_operad
+   sage/operads/free_operad
+   sage/operads/nap_operad
+   sage/operads/prelie_operad
+   sage/operads/zinbiel_operad
+
+.. include:: ../footer.txt
+