Streamlined the documentation in preparation for next release#670
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR streamlines the documentation infrastructure in preparation for the 4.0.0 release by consolidating dependency management, removing obsolete tooling, and modernizing the documentation build process. The changes transition from requirements.txt to pyproject.toml-based dependency management, switch from sphinx-book-theme to Furo theme, remove PDF generation workflows, and add an AI chat assistant widget to the documentation.
Changes:
- Consolidated dependency management from requirements.txt to pyproject.toml with organized dependency groups (docs, quality, dev)
- Removed build scripts, link checking utilities, and Python code quality workflows (ruff, black, PDF generation)
- Updated Sphinx theme from sphinx-book-theme to Furo and bumped version to 4.0.0
- Added AI chat widget integration for documentation assistance
- Reorganized README.md content with version/schema comparison table
- Updated GitHub Actions versions across CI workflows
Reviewed changes
Copilot reviewed 18 out of 19 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| serve-sphinx.bat | Removed local documentation server script |
| requirements.txt | Removed in favor of pyproject.toml dependency management |
| pyproject.toml | Switched to Furo theme, removed unused dependencies (bibtex, mermaid, ruff, black, pre-commit), cleaned up tool configurations |
| docs/source/index.rst | Removed redundant section headers and "Topics:" labels, added genindex reference |
| docs/source/conf.py | Bumped version to 4.0.0, replaced sphinx.ext.todo with myst_parser, removed LaTeX configuration, removed ethical-ads sidebar |
| docs/source/_templates/sidebar/brand.html | Added empty template to override default branding |
| docs/source/_templates/base.html | Added OSA Chat Widget integration for HED assistance |
| check_links.py | Removed Python link checker script |
| check-links.bat | Removed batch link checker script |
| build-sphinx.bat | Removed Sphinx build script |
| build-docs.bat | Removed documentation build script |
| README.md | Reorganized content structure, moved HED specification vs schema table earlier, updated documentation links |
| .github/workflows/ruff.yml | Removed Ruff linting workflow |
| .github/workflows/pdf-docs.yml | Removed PDF documentation generation workflow |
| .github/workflows/links.yaml | Changed from requirements.txt to pip install with docs extras |
| .github/workflows/deploy-docs.yml | Updated GitHub Actions versions, changed to editable install with docs extras |
| .github/workflows/codespell.yml | Updated GitHub Actions versions |
| .github/workflows/black.yml | Removed Black formatting workflow |
| .codespellrc | Removed in favor of pyproject.toml configuration |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.