diff --git a/.gitignore b/.gitignore index 9cf170cb..cc5cbe12 100644 --- a/.gitignore +++ b/.gitignore @@ -29,3 +29,7 @@ metals.sbt # TraceVault — local only, do not commit .tracevault/ .claude/settings.local.json + +# Local Sphinx build artifacts +generated-doc/out/.venv/ +generated-doc/out/_build/ diff --git a/doc/conf.py b/doc/conf.py index e5d4f636..f7a781ad 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -24,7 +24,10 @@ import os # Define the canonical URL if you are using a custom domain on Read the Docs -html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "") +html_baseurl = os.environ.get( + "READTHEDOCS_CANONICAL_URL", + "https://ox.softwaremill.com/latest/", +) # Tell Jinja2 templates the build is running on Read the Docs if os.environ.get("READTHEDOCS", "") == "True": @@ -41,7 +44,11 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['myst_parser', 'sphinx_rtd_theme'] +extensions = ['myst_parser', 'sphinx_rtd_theme', 'sphinx_llms_txt'] + +llms_txt_title = "Ox" +llms_txt_summary = "Safe direct-style concurrency and resiliency for Scala on the JVM" +llms_txt_full_file = True # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -52,7 +59,6 @@ # source_suffix = ['.rst', '.md'] source_suffix = { '.rst': 'restructuredtext', - '.txt': 'markdown', '.md': 'markdown', } @@ -83,7 +89,15 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = [ + '_build', 'Thumbs.db', '.DS_Store', + '.venv', 'venv', 'env', + '**/site-packages/**', + '**/node_modules/**', + '_templates', + 'requirements.txt', + 'includes/*', +] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' diff --git a/doc/requirements.txt b/doc/requirements.txt index e8548070..71eaa500 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -2,3 +2,4 @@ sphinx_rtd_theme==2.0.0 sphinx==7.3.7 sphinx-autobuild==2024.4.16 myst-parser==2.0.0 +sphinx-llms-txt diff --git a/generated-doc/out/conf.py b/generated-doc/out/conf.py index e5d4f636..f7a781ad 100644 --- a/generated-doc/out/conf.py +++ b/generated-doc/out/conf.py @@ -24,7 +24,10 @@ import os # Define the canonical URL if you are using a custom domain on Read the Docs -html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "") +html_baseurl = os.environ.get( + "READTHEDOCS_CANONICAL_URL", + "https://ox.softwaremill.com/latest/", +) # Tell Jinja2 templates the build is running on Read the Docs if os.environ.get("READTHEDOCS", "") == "True": @@ -41,7 +44,11 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['myst_parser', 'sphinx_rtd_theme'] +extensions = ['myst_parser', 'sphinx_rtd_theme', 'sphinx_llms_txt'] + +llms_txt_title = "Ox" +llms_txt_summary = "Safe direct-style concurrency and resiliency for Scala on the JVM" +llms_txt_full_file = True # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -52,7 +59,6 @@ # source_suffix = ['.rst', '.md'] source_suffix = { '.rst': 'restructuredtext', - '.txt': 'markdown', '.md': 'markdown', } @@ -83,7 +89,15 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = [ + '_build', 'Thumbs.db', '.DS_Store', + '.venv', 'venv', 'env', + '**/site-packages/**', + '**/node_modules/**', + '_templates', + 'requirements.txt', + 'includes/*', +] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' diff --git a/generated-doc/out/requirements.txt b/generated-doc/out/requirements.txt index e8548070..71eaa500 100644 --- a/generated-doc/out/requirements.txt +++ b/generated-doc/out/requirements.txt @@ -2,3 +2,4 @@ sphinx_rtd_theme==2.0.0 sphinx==7.3.7 sphinx-autobuild==2024.4.16 myst-parser==2.0.0 +sphinx-llms-txt