-
Notifications
You must be signed in to change notification settings - Fork 13
Add sphinx-llm #366
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Add sphinx-llm #366
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #366 +/- ##
=======================================
Coverage 76.25% 76.25%
=======================================
Files 31 31
Lines 2620 2620
=======================================
Hits 1998 1998
Misses 622 622 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
What is the content of |
|
I read that before, it says:
I struggle to see how the sphinx extension can generate "brief background information" and "guidance". So I just would like to see the content of the |
|
I have not seen the llms.txt file because it was not generated when I tried. I reported the bug and it has since the been fixed. |
|
The llms.txt# Panel Material UI
> Panel Material UI v0.4.0rc1
2024-2025 Holoviz contributors
## Pages
- [Panel Material UI](index.html.md): Welcome to Panel Material UI – a library that brings the sleek design and comprehensive component se...
- [Component Gallery](reference/index.html.md): : <meta http-equiv='refresh' content='0; URL=../index.html#chat'>
- [Layouts](reference/layouts/index.html.md): <meta http-equiv='refresh' content='0; URL=../index.html#layouts'>
- [Indicators](reference/indicators/index.html.md): <meta http-equiv='refresh' content='0; URL=../index.html#indicators'>
- [Page](reference/page/index.html.md): <meta http-equiv='refresh' content='0; URL=../index.html#page'>
- [Menus](reference/menus/index.html.md): <meta http-equiv='refresh' content='0; URL=../index.html#menus'>
- [Widgets](reference/widgets/index.html.md): <meta http-equiv='refresh' content='0; URL=../index.html#widgets'>
- [Global](reference/global/index.html.md): <meta http-equiv='refresh' content='0; URL=../index.html#global'>
- [Panes](reference/panes/index.html.md): <meta http-equiv='refresh' content='0; URL=../index.html#panes'>
- [How-To](how_to/index.html.md): Welcome to the **Panel Material UI** how-to guides. These guides walk you through:
- [Accordion](reference/layouts/Accordion.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [AutocompleteInput](reference/widgets/AutocompleteInput.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Avatar](reference/panes/Avatar.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Backdrop](reference/layouts/Backdrop.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Breadcrumbs](reference/menus/Breadcrumbs.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [BreakpointSwitcher](reference/page/BreakpointSwitcher.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Button](reference/widgets/Button.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [ButtonIcon](reference/widgets/ButtonIcon.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Card](reference/layouts/Card.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [ChatAreaInput](reference/chat/ChatAreaInput.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [ChatFeed](reference/chat/ChatFeed.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [ChatInterface](reference/chat/ChatInterface.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [ChatMessage](reference/chat/ChatMessage.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [ChatStep](reference/chat/ChatStep.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [CheckBoxGroup](reference/widgets/CheckBoxGroup.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [CheckButtonGroup](reference/widgets/CheckButtonGroup.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Checkbox](reference/widgets/Checkbox.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Chip](reference/panes/Chip.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [CircularProgress](reference/indicators/CircularProgress.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [ColorPicker](reference/widgets/ColorPicker.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Container](reference/layouts/Container.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [CrossSelector](reference/widgets/CrossSelector.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [DatePicker](reference/widgets/DatePicker.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [DateRangePicker](reference/widgets/DateRangePicker.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [DateRangeSlider](reference/widgets/DateRangeSlider.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [DateSlider](reference/widgets/DateSlider.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [DatetimePicker](reference/widgets/DatetimePicker.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [DatetimeRangePicker](reference/widgets/DatetimeRangePicker.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [DatetimeRangeSlider](reference/widgets/DatetimeRangeSlider.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [DatetimeSlider](reference/widgets/DatetimeSlider.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Dialog](reference/layouts/Dialog.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [DiscreteSlider](reference/widgets/DiscreteSlider.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Drawer](reference/layouts/Drawer.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [EditableFloatSlider](reference/widgets/EditableFloatSlider.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [EditableIntRangeSlider](reference/widgets/EditableIntRangeSlider.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [EditableIntSlider](reference/widgets/EditableIntSlider.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [EditableRangeSlider](reference/widgets/EditableRangeSlider.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Fab](reference/widgets/Fab.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [FileDownload](reference/widgets/FileDownload.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [FileInput](reference/widgets/FileInput.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [FlexBox](reference/layouts/FlexBox.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [FloatInput](reference/widgets/FloatInput.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [FloatSlider](reference/widgets/FloatSlider.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Grid](reference/layouts/Grid.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [IconButton](reference/widgets/IconButton.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [IntInput](reference/widgets/IntInput.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [IntRangeSlider](reference/widgets/IntRangeSlider.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [IntSlider](reference/widgets/IntSlider.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [LinearProgress](reference/indicators/LinearProgress.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [List](reference/menus/List.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [LoadingSpinner](reference/indicators/LoadingSpinner.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Manual](reference/page/Manual.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [MenuButton](reference/menus/MenuButton.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [MenuList](reference/menus/MenuList.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [MultiChoice](reference/widgets/MultiChoice.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [MultiSelect](reference/widgets/MultiSelect.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [NestedSelect](reference/widgets/NestedSelect.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Notifications](reference/global/Notifications.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Page](reference/page/Page.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Pagination](reference/menus/Pagination.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Paper](reference/layouts/Paper.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [PasswordInput](reference/widgets/PasswordInput.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Progress](reference/indicators/Progress.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [RadioBoxGroup](reference/widgets/RadioBoxGroup.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [RadioButtonGroup](reference/widgets/RadioButtonGroup.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [RangeSlider](reference/widgets/RangeSlider.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Select](reference/widgets/Select.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Skeleton](reference/panes/Skeleton.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [SpeedDial](reference/menus/SpeedDial.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [SplitButton](reference/menus/SplitButton.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Switch](reference/widgets/Switch.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Tabs](reference/layouts/Tabs.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [TextAreaInput](reference/widgets/TextAreaInput.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [TextInput](reference/widgets/TextInput.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [ThemeToggle](reference/page/ThemeToggle.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [TimePicker](reference/widgets/TimePicker.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Toggle](reference/widgets/Toggle.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [ToggleIcon](reference/widgets/ToggleIcon.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Typography](reference/panes/Typography.html.md): [Download this notebook from GitHub (right-click to download).](https://raw.githubusercontent.com/pa...
- [Bokeh, hvPlot, and HoloViews](how_to/bokeh_holoviews.html.md): Panel Material UI has integrated theming support for Bokeh, hvPlot, and HoloViews. This means that t...
- [How to Brand Your Panel Material-UI Application](how_to/branding.html.md): This guide demonstrates how to create a cohesive brand experience in your Panel Material-UI applicat...
- [Color](how_to/color.html.md): Convey meaning through color. By default, `panel-material-ui` provides access to the [Material Desig...
- [Themed Components](how_to/components.html.md): You can customize `panel-material-ui` components—changing default props, styles, or adding new varia...
- [Custom Components](how_to/custom.html.md): The `panel-material-ui` package ships with a number of custom Material UI components that are built ...
- [How to Customize](how_to/customize.html.md): Customization of Panel Mui components inherits all the benefits of having a consistent design langua...
- [Dark Mode](how_to/dark_mode.html.md): The `panel-material-ui` components automatically integrate with Panel’s dark mode configuration and ...
- [Icons](how_to/icons.html.md): **panel-material-ui** ships with the Material UI icon library. This means that you can use any of th...
- [Palette](how_to/palette.html.md): The `panel-material-ui` palette system allows you to customize component colors to suit your brand. ...
- [Plotly Theming](how_to/plotly.html.md): Panel Material UI provides integrated theming support for Plotly, which is applied automatically.
- [Typography](how_to/typography.html.md): `panel_material_ui` provides a robust typography system inspired by Material UI. Fonts and sizes can... |
|
Now it almost works. I hope someone who understands the nbsite build process can explain why the pyodide output gets included in the .html.md files. See jacobtomlinson/sphinx-llm#29. |
This PR adds sphinx-llm to generate LLM friendly documentation.
I've tried generating the documentation with
pixi run docs-buildbut experience some issues.Logs
Issues
<pre>tags. See .html.md files contain rendered output jacobtomlinson/sphinx-llm#29.Notes