Refactor docs: Switch to Furo, fix duplicates, update content and CI #92
Conversation
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
- Switch theme to `furo` as requested, removing `sphinx-immaterial`. - Fix duplicate object description warnings by refactoring `TokenPair` and `HealthCheckResult` docstrings. - Update `index.rst`, snippets, and tutorial to address content feedback (lists, links, overlap). - Enable PR builds in `deploy-docs.yml`.
- Switched from `sphinx-immaterial` to `furo` theme in `conf.py` and `pyproject.toml`. - Fixed duplicate object description warnings by refactoring `TokenPair` and `HealthCheckResult` docstrings (moved attributes inline). - Cleaned up `conf.py` by removing unsupported theme options. - Refactored `index.rst`, `snippets`, and `tutorial` to address content overlap and navigation issues. - Updated `deploy-docs.yml` to trigger on PRs.
- Switched documentation theme to `furo` (removed `sphinx-immaterial`, `sphinx-rtd-theme`). - Fixed duplicate object description warnings by refactoring `TokenPair` and `HealthCheckResult` docstrings. - Cleaned up `conf.py` by removing unsupported theme options. - Refactored `index.rst`, `snippets`, and `tutorial` to address content overlap and navigation issues. - Updated `deploy-docs.yml` to trigger on PRs.
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.
furoas requested, removingsphinx-immaterial.TokenPairandHealthCheckResultdocstrings.index.rst, snippets, and tutorial to address content feedback (lists, links, overlap).deploy-docs.yml.Description
Clear description of changes
Type of Change
Plugin Checklist (if applicable)
src/core/structum/src/plugins/get_metrics()get_logger()Quality Gates
Testing
How has this been tested?
# Commands used for testing pytest tests/test_...py -vScreenshots (if applicable)
For UI/CLI changes
Breaking Changes
List any breaking changes and migration path
Related Issues
Closes #(issue number)
Checklist