Skip to content

Enhance Sphinx documentation theme with custom styling#120

Merged
alexanderthclark merged 4 commits into
mainfrom
docs/enhance-sphinx-theme
May 26, 2025
Merged

Enhance Sphinx documentation theme with custom styling#120
alexanderthclark merged 4 commits into
mainfrom
docs/enhance-sphinx-theme

Conversation

@alexanderthclark

Copy link
Copy Markdown
Owner
  • Add custom CSS with economics-inspired color palette and typography
  • Create hero section with banner image for homepage
  • Add smooth scrolling and code copy functionality via JavaScript
  • Create custom logo and favicon SVGs
  • Configure sphinx-book-theme to remove right sidebar for wider content
  • Add feature cards and improve visual hierarchy
  • Create custom 404 page
  • Use muted colors to fix contrast issues with buttons and links

The new theme provides a more professional appearance suitable for the upcoming release, with better use of horizontal space and a cohesive visual design that reflects the economics focus of FreeRide.

🤖 Generated with Claude Code

alexanderthclark and others added 4 commits May 26, 2025 12:35
- Add custom CSS with economics-inspired color palette and typography
- Create hero section with banner image for homepage
- Add smooth scrolling and code copy functionality via JavaScript
- Create custom logo and favicon SVGs
- Configure sphinx-book-theme to remove right sidebar for wider content
- Add feature cards and improve visual hierarchy
- Create custom 404 page
- Use muted colors to fix contrast issues with buttons and links

The new theme provides a more professional appearance suitable for
the upcoming release, with better use of horizontal space and a
cohesive visual design that reflects the economics focus of FreeRide.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
- Remove tagline from hero section in index.rst
- Update HTML title in conf.py to just 'FreeRide'
- Adjust CSS banner margin for cleaner appearance
- Replace individual file listings with proper directory patterns
- Add standard Python gitignore patterns
- Remove committed _build files from tracking
- Ensure all build artifacts are properly ignored
- Move banner image below welcome heading for better flow
- Remove duplicate 'FreeRide' text from sidebar navigation
- Clean up logo by removing green dot from intersection
- Create minimal favicon with just intersecting curves on transparent background
- Add installation section with platform-specific guidance and Google Colab recommendation
- Update code example to use Market object instead of Equilibrium
- Show expected output from code example
- Add visual example plot showing market equilibrium with surplus areas
- Remove dark mode toggle for consistent light-mode experience
- Improve overall documentation structure and user experience
@alexanderthclark alexanderthclark merged commit b31daa4 into main May 26, 2025
3 of 6 checks passed
@alexanderthclark alexanderthclark deleted the docs/enhance-sphinx-theme branch May 26, 2025 18:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant