PyData Sphinx 主题#
A clean, Bootstrap-based Sphinx theme by and for the PyData community.
B Built with Bootstrap
Use Bootstrap classes and functionality in your documentation.
⚡ Responsive Design
Site sections will change behavior and size at different screen sizes.
🌗 Light / Dark theme
Users can toggle between light and dark themes interactively.
🎨 Customizable UI and themes
Customize colors and branding with CSS variables, and build custom UIs with Sphinx Design.
参见
If you are looking for a Sphinx theme that puts all of its sub-pages in the sidebar, the Sphinx Book Theme has a similar look and feel, and Furo is another excellent choice. You can also see the Sphinx Themes Gallery for more ideas.
User Guide#
Information about using, configuration, and customizing this theme.
- 用户指南
- 安装
- Theme Structure and Layout
- Navigation depth and collapsing sidebars
- Page Table of Contents
- Header links
- Source Buttons
- Announcement banners
- Version switcher dropdowns
- Search bar / search button
- Keyboard shortcuts
- Theme-specific elements
- Blogs with
ABlog
- Sphinx Design Components
- Branding and logo
- Theme variables and CSS
- Fonts and FontAwesome
- Light and dark themes
- 可访问性
- Analytics and usage services
- Build performance and size
- Read the Docs functionality
Community and contribution guide#
Information about the community behind this theme and how you can contribute.
Examples#
Several example pages to demonstrate the functionality of this theme when used alongside other Sphinx extensions.
- Examples
- Gallery of sites using this theme
- Indexing and selecting data with Pandas
- Kitchen Sink
- PyData Library Styles
- Advanced API documentation and generated content
- 1. Test of no sidebar
- 2. Test of persistent search field
- 3. Top-level headers and the TOC
- 4. An example with multiple top-level headers
- 5. An example with a single top-level header
- 6. Section to show off pages with many sub-pages
- Link to an external site