Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 4 additions & 35 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@

extensions = [
"notfound.extension",
# "sphinx.ext.apidoc",
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.napoleon",
Expand All @@ -42,6 +41,7 @@
"sphinx_design",
"sphinx_issues",
"sphinx_last_updated_by_git",
"sphinx_llms_txt",
"sphinxext.opengraph",
]
source_suffix = {".rst": "restructuredtext"}
Expand Down Expand Up @@ -129,40 +129,6 @@
notfound_urls_prefix = "/"


# -- sphinx.ext.apidoc configuration -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/extensions/apidoc.html#
# This extension automatically generates API documentation from docstrings,
# writing the source .rst files to the specified destination directory.
# These files can't be customized to insert the SPDX headers.
#
# Steve tried copying their templates from
# `site-packages/sphinx/templates/apidoc/*.rst.jinja` to `_templates`
# and renaming them with various suffices without any luck. Editing
# the templates in their package worked, but that's not maintainable.
#
# The options are:
# 1. Don't use SPDX headers, follow icalendar with its use of sphinx.ext.apidoc,
# and .gitignore the output `reference/api` directory.
# 2. Copy and modify the templates, which may drift in the future and
# we'd never know, and use sphinx-apidoc with a new Make target.
# apidoc_modules = [
# {
# "path": "../src/calendaring_jmap",
# "destination": "reference/api",
# "exclude_patterns": [
# # "**/tests*",
# ],
# "separate_modules": True,
# "automodule_options": {
# "ignore-module-all",
# "members",
# "show-inheritance",
# "undoc-members",
# },
# }
# ]


# -- sphinx.ext.autodoc configuration ------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
autoclass_content = "both"
Expand Down Expand Up @@ -239,6 +205,9 @@ def setup(app):
html_last_updated_fmt = "%Y-%m-%d"


# -- sphinx_llms_txt configuration -------------------------


# -- sphinxext.opengraph configuration -----------------------------------------
html_baseurl = os.environ.get(
"READTHEDOCS_CANONICAL_URL", "https://calendaring-jmap.readthedocs.io/en/stable/"
Expand Down
1 change: 1 addition & 0 deletions news/85.documentation.rst
Comment thread
SashankBhamidi marked this conversation as resolved.
Resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added :program:`sphinx-llms-txt` for generating LLMS-friendly files. @stevepiercy
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ docs = [
"sphinx-notfound-page==1.1.0",
"sphinxext-opengraph==0.13.0",
"vale>=3.25.1",
"sphinx-llms-txt>=0.7.1",
]

[project.urls]
Expand Down
138 changes: 78 additions & 60 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading