Customized mkdocs templates #18
Merged
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
Introduces custom templates for Python material documentation in mkdocstrings and configures mkdocs.yml to use them. Includes templates for attribute, class, function, and summary, with logging and error triggers for debugging and override verification.
Enhanced documentation for line_chart, pie_chart, and plotly_chart with better formatting, options, and example presentation. Refined the PlotlyChart class docstring for clarity and improved reference to the figure attribute.
Deploying flet-charts-docs with
|
| Latest commit: |
f0c756a
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://ce901032.flet-charts-docs.pages.dev |
| Branch Preview URL: | https://custom-templates.flet-charts-docs.pages.dev |
Added new icon imports and styles for class symbols in mkdocstrings.css. Adjusted show_root_toc_entry settings in mkdocs.yml and line_chart.md for improved documentation navigation.
Revised platform support tables in README and docs to a more compact format. Updated mkdocs site name to 'Flet Charts' and changed theme colors to pink and light blue. Improved mkdocstrings.css for better icon styling and color scheme support.
Replaces the previous logo.svg with a redesigned version featuring a circular white background, updated paths, and new dimensions (170x170). The new SVG is simplified and modernized for improved appearance and scalability.
Adjusted the @import URL and font-variation-settings for Material Symbols in mkdocstrings.css to use GRAD 200 instead of 0, ensuring consistent icon appearance.
Changed BarChart, LineChart, PieChart, and ScatterChart to inherit from ft.LayoutControl instead of ft.ConstrainedControl for improved layout handling. Updated documentation to enhance API reference structure, add diagrams, and improve class docstring visibility. Removed poetry install instructions from README and docs.
Deleted the GitHub Actions workflow for documentation deployment and updated the README to point to the new documentation URL.
Configured the MkDocs theme to use the FontAwesome GitHub brand icon for the repo. This enhances the visual representation of the repository link in the documentation.
Changed copyright to Appveyor Systems Inc. and removed edit_uri. Also removed 'edit' and 'view' actions from theme features for documentation.
Replaced repetitive class documentation blocks in chart and type markdown files with Jinja macros for consistency and maintainability. Added docs/extras/macros/__init__.py to define macros for rendering class summaries and members. Updated mkdocs.yml to enable the macros plugin and set edit_uri. Improved theme palette configuration for better color scheme support. Added mkdocs-macros-plugin to documentation dependencies in pyproject.toml.
Updated bar_chart.md, line_chart.md, and pie_chart.md to use the 'image' key instead of 'screenshot' for diagram references and in class_summary calls for consistency.
Refactored the class_summary macro to use 'image' instead of 'screenshot' for clarity and consistency. Updated related variable names and markdown generation accordingly.
Added 'generator: false' to the 'extra' section in mkdocs.yml to hide the default 'Made with Material for MkDocs' message from the site footer.
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.